POST clients/UpdateAddress

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PostalAddress1	string	None.
PostalAddress2	string	None.
PostalAddress3	string	None.
PostalAddress4	string	None.
PostalAddress	string	None.
AreaPostalCode	string	None.
PostalSameAsPhysical	boolean	None.
AssetTypeId	integer	None.
PostalAddressId	integer	None.
AddressId	integer	None.
CustId	integer	None.
BuildingNo	string	None.
BuildingName	string	None.
StreetNo	string	None.
StreetName	string	None.
Suburb	string	None.
SuburbId	integer	None.
Town	string	None.
PostalCode	string	None.
Division	integer	None.
SubDivision	integer	None.
MainArea	integer	None.
SubArea	integer	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
PhysicalAddress	string	None.
AEFlag	boolean	None.
AEType	integer	None.
AEName	string	None.
AENumber	string	None.
AEStreet	string	None.
AEBuildingName	string	None.
Province	integer	None.
Country	integer	None.
AEDescription	string	None.
Directions	string	None.
IsOutsideResponse	boolean	None.
GPSConfirmed	boolean	None.
IsAuthenticated	boolean	None.
Matrix	Collection of MatrixAssignment	None.
MatrixAreas	Collection of RxGisArea	None.
TenantId	integer	None.
ClientType	integer	None.
ShortAddress	string	None.
IsPartitioned	boolean	None.
ParentAddressId	integer	None.
ManualOverride	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "PostalAddress1": "sample string 1",
  "PostalAddress2": "sample string 2",
  "PostalAddress3": "sample string 3",
  "PostalAddress4": "sample string 4",
  "PostalAddress": "sample string 5",
  "AreaPostalCode": "sample string 6",
  "PostalSameAsPhysical": true,
  "AssetTypeId": 8,
  "PostalAddressId": 1,
  "AddressId": 1,
  "CustId": 9,
  "BuildingNo": "sample string 10",
  "BuildingName": "sample string 11",
  "StreetNo": "sample string 12",
  "StreetName": "sample string 13",
  "Suburb": "sample string 14",
  "SuburbId": 1,
  "Town": "sample string 15",
  "PostalCode": "sample string 16",
  "Division": 17,
  "SubDivision": 18,
  "MainArea": 19,
  "SubArea": 20,
  "Latitude": 1.0,
  "Longitude": 1.0,
  "PhysicalAddress": "sample string 21",
  "AEFlag": true,
  "AEType": 1,
  "AEName": "sample string 23",
  "AENumber": "sample string 24",
  "AEStreet": "sample string 25",
  "AEBuildingName": "sample string 26",
  "Province": 1,
  "Country": 1,
  "AEDescription": "sample string 27",
  "Directions": "sample string 28",
  "IsOutsideResponse": true,
  "GPSConfirmed": true,
  "IsAuthenticated": true,
  "Matrix": [
    {
      "AreaTypeId": 1,
      "AreaId": 2
    },
    {
      "AreaTypeId": 1,
      "AreaId": 2
    }
  ],
  "MatrixAreas": [
    {
      "AreaId": 1,
      "AreaName": "sample string 2",
      "GroupId": 3,
      "AreaType": "sample string 4",
      "GroupName": "sample string 5",
      "AreaTypeId": 6
    },
    {
      "AreaId": 1,
      "AreaName": "sample string 2",
      "GroupId": 3,
      "AreaType": "sample string 4",
      "GroupName": "sample string 5",
      "AreaTypeId": 6
    }
  ],
  "TenantId": 31,
  "ClientType": 32,
  "ShortAddress": "sample string 33",
  "IsPartitioned": true,
  "ParentAddressId": 1,
  "ManualOverride": true
}

text/html

Sample:

{"PostalAddress1":"sample string 1","PostalAddress2":"sample string 2","PostalAddress3":"sample string 3","PostalAddress4":"sample string 4","PostalAddress":"sample string 5","AreaPostalCode":"sample string 6","PostalSameAsPhysical":true,"AssetTypeId":8,"PostalAddressId":1,"AddressId":1,"CustId":9,"BuildingNo":"sample string 10","BuildingName":"sample string 11","StreetNo":"sample string 12","StreetName":"sample string 13","Suburb":"sample string 14","SuburbId":1,"Town":"sample string 15","PostalCode":"sample string 16","Division":17,"SubDivision":18,"MainArea":19,"SubArea":20,"Latitude":1.0,"Longitude":1.0,"PhysicalAddress":"sample string 21","AEFlag":true,"AEType":1,"AEName":"sample string 23","AENumber":"sample string 24","AEStreet":"sample string 25","AEBuildingName":"sample string 26","Province":1,"Country":1,"AEDescription":"sample string 27","Directions":"sample string 28","IsOutsideResponse":true,"GPSConfirmed":true,"IsAuthenticated":true,"Matrix":[{"AreaTypeId":1,"AreaId":2},{"AreaTypeId":1,"AreaId":2}],"MatrixAreas":[{"AreaId":1,"AreaName":"sample string 2","GroupId":3,"AreaType":"sample string 4","GroupName":"sample string 5","AreaTypeId":6},{"AreaId":1,"AreaName":"sample string 2","GroupId":3,"AreaType":"sample string 4","GroupName":"sample string 5","AreaTypeId":6}],"TenantId":31,"ClientType":32,"ShortAddress":"sample string 33","IsPartitioned":true,"ParentAddressId":1,"ManualOverride":true}

application/xml, text/xml

Sample:

<SimpleAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Addresses">
  <AEBuildingName>sample string 26</AEBuildingName>
  <AEDescription>sample string 27</AEDescription>
  <AEFlag>true</AEFlag>
  <AEName>sample string 23</AEName>
  <AENumber>sample string 24</AENumber>
  <AEStreet>sample string 25</AEStreet>
  <AEType>1</AEType>
  <AddressId>1</AddressId>
  <BuildingName>sample string 11</BuildingName>
  <BuildingNo>sample string 10</BuildingNo>
  <ClientType>32</ClientType>
  <Country>1</Country>
  <CustId>9</CustId>
  <Directions>sample string 28</Directions>
  <Division>17</Division>
  <GPSConfirmed>true</GPSConfirmed>
  <IsAuthenticated>true</IsAuthenticated>
  <IsOutsideResponse>true</IsOutsideResponse>
  <IsPartitioned>true</IsPartitioned>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <MainArea>19</MainArea>
  <ManualOverride>true</ManualOverride>
  <Matrix xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Areas">
    <d2p1:MatrixAssignment>
      <d2p1:AreaId>2</d2p1:AreaId>
      <d2p1:AreaTypeId>1</d2p1:AreaTypeId>
    </d2p1:MatrixAssignment>
    <d2p1:MatrixAssignment>
      <d2p1:AreaId>2</d2p1:AreaId>
      <d2p1:AreaTypeId>1</d2p1:AreaTypeId>
    </d2p1:MatrixAssignment>
  </Matrix>
  <MatrixAreas xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Areas">
    <d2p1:RxGisArea>
      <d2p1:AreaId>1</d2p1:AreaId>
      <d2p1:AreaName>sample string 2</d2p1:AreaName>
      <d2p1:AreaType>sample string 4</d2p1:AreaType>
      <d2p1:AreaTypeId>6</d2p1:AreaTypeId>
      <d2p1:GroupId>3</d2p1:GroupId>
      <d2p1:GroupName>sample string 5</d2p1:GroupName>
    </d2p1:RxGisArea>
    <d2p1:RxGisArea>
      <d2p1:AreaId>1</d2p1:AreaId>
      <d2p1:AreaName>sample string 2</d2p1:AreaName>
      <d2p1:AreaType>sample string 4</d2p1:AreaType>
      <d2p1:AreaTypeId>6</d2p1:AreaTypeId>
      <d2p1:GroupId>3</d2p1:GroupId>
      <d2p1:GroupName>sample string 5</d2p1:GroupName>
    </d2p1:RxGisArea>
  </MatrixAreas>
  <ParentAddressId>1</ParentAddressId>
  <PhysicalAddress>sample string 21</PhysicalAddress>
  <PostalCode>sample string 16</PostalCode>
  <Province>1</Province>
  <ShortAddress>sample string 33</ShortAddress>
  <StreetName>sample string 13</StreetName>
  <StreetNo>sample string 12</StreetNo>
  <SubArea>20</SubArea>
  <SubDivision>18</SubDivision>
  <Suburb>sample string 14</Suburb>
  <SuburbId>1</SuburbId>
  <TenantId>31</TenantId>
  <Town>sample string 15</Town>
  <AreaPostalCode>sample string 6</AreaPostalCode>
  <AssetTypeId>8</AssetTypeId>
  <PostalAddress>sample string 5</PostalAddress>
  <PostalAddress1>sample string 1</PostalAddress1>
  <PostalAddress2>sample string 2</PostalAddress2>
  <PostalAddress3>sample string 3</PostalAddress3>
  <PostalAddress4>sample string 4</PostalAddress4>
  <PostalAddressId>1</PostalAddressId>
  <PostalSameAsPhysical>true</PostalSameAsPhysical>
</SimpleAddress>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SimpleAddress'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.