POST api/Addresses/Insert/{CustomerID}/{AddressRef}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerID | string |
Required |
|
| AddressRef | string |
Required |
Body Parameters
EskimoClassLibraries.clsAddress| Name | Description | Type | Additional information |
|---|---|---|---|
| Company |
Optional. Name of the company / organisation. |
string |
String length: inclusive between 0 and 50 |
| Line1 |
Optional. The first line of the address i.e. Flat 173 |
string |
String length: inclusive between 0 and 256 |
| Line2 |
Optional. The second line of the address i.e. Mulberry House |
string |
String length: inclusive between 0 and 50 |
| Line3 |
The third line of the address |
string |
String length: inclusive between 0 and 50 |
| PostalTown |
The postal town or city. i.e. London |
string |
String length: inclusive between 0 and 50 |
| Region |
The county or state i.e. Dorset or California |
string |
String length: inclusive between 0 and 50 |
| PostCode |
The postal or zip code. |
string |
String length: inclusive between 0 and 20 |
| CountryCode |
The 2 digit country code, see api/Countries/Search |
string |
Required String length: inclusive between 2 and 2 |
| Active |
If the address is active (in use). Defaults to True if not passed. |
boolean |
None. |
Request Formats
application/json, text/json
{
"Company": "sample string 1",
"Line1": "sample string 2",
"Line2": "sample string 3",
"Line3": "sample string 4",
"PostalTown": "sample string 5",
"Region": "sample string 6",
"PostCode": "sample string 7",
"CountryCode": "sample string 8",
"Active": true
}
application/xml, text/xml
<clsAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries"> <Active>true</Active> <Company>sample string 1</Company> <CountryCode>sample string 8</CountryCode> <Line1>sample string 2</Line1> <Line2>sample string 3</Line2> <Line3>sample string 4</Line3> <PostCode>sample string 7</PostCode> <PostalTown>sample string 5</PostalTown> <Region>sample string 6</Region> </clsAddress>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
System.Net.Http.HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | System.Version |
None. |
|
| Content | System.Net.Http.HttpContent |
None. |
|
| StatusCode | System.Net.HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | System.Net.Http.HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |