PUT api/CustomerAddress
Update the primary address for a customer. This is an all or nothing update, meaning you can't do partial updates (patch). If you do not provide a property it will be set to empty. Required: SiteOwnerId, CustomerId or RefCode
Request Information
URI Parameters
None.
Body Parameters
The Address Model containing properties to update.
AddressModelName | Description | Type | Additional information |
---|---|---|---|
SiteOwnerId | integer |
Required |
|
CustomerId | integer |
None. |
|
RefCode | string |
Max length: 200 |
|
StreetNumber | string |
Max length: 150 |
|
StreetName | string |
Max length: 150 |
|
UnitLevel | string |
Max length: 150 |
|
StreetPostCode | string |
Max length: 150 |
|
Suburb | string |
Max length: 150 |
|
City | string |
Max length: 150 |
|
State | string |
Max length: 150 |
|
Latitiude | string |
Max length: 50 |
|
Longitude | string |
Max length: 50 |
|
PostalLine1 | string |
Max length: 150 |
|
PostalLine2 | string |
Max length: 150 |
|
PostalCity | string |
Max length: 150 |
|
PostalState | string |
Max length: 150 |
|
PostalPostCode | string |
Max length: 150 |
Request Formats
application/json, text/json
Sample:
{ "SiteOwnerId": 1, "CustomerId": 2, "RefCode": "sample string 3", "StreetNumber": "sample string 4", "StreetName": "sample string 5", "UnitLevel": "sample string 6", "StreetPostCode": "sample string 7", "Suburb": "sample string 8", "City": "sample string 9", "State": "sample string 10", "Latitiude": "sample string 11", "Longitude": "sample string 12", "PostalLine1": "sample string 13", "PostalLine2": "sample string 14", "PostalCity": "sample string 15", "PostalState": "sample string 16", "PostalPostCode": "sample string 17" }
application/xml, text/xml
Sample:
<AddressModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExsalerateWebAPI.Models"> <City>sample string 9</City> <CustomerId>2</CustomerId> <Latitiude>sample string 11</Latitiude> <Longitude>sample string 12</Longitude> <PostalCity>sample string 15</PostalCity> <PostalLine1>sample string 13</PostalLine1> <PostalLine2>sample string 14</PostalLine2> <PostalPostCode>sample string 17</PostalPostCode> <PostalState>sample string 16</PostalState> <RefCode>sample string 3</RefCode> <SiteOwnerId>1</SiteOwnerId> <State>sample string 10</State> <StreetName>sample string 5</StreetName> <StreetNumber>sample string 4</StreetNumber> <StreetPostCode>sample string 7</StreetPostCode> <Suburb>sample string 8</Suburb> <UnitLevel>sample string 6</UnitLevel> </AddressModel>
application/x-www-form-urlencoded
Sample:
SiteOwnerId=1&CustomerId=1&StreetNumber=1&StreetName=Foo Street&Suburb=bar
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |