POST api/V2/Customer/AddAddress
Request Information
URI Parameters
None.
Body Parameters
CustomerAddressViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| CustomerId | integer |
Required |
|
| UserType | string |
None. |
|
| AddressLine1 | string |
Required |
|
| AddressLine2 | string |
None. |
|
| CityId | integer |
None. |
|
| City_Value | string |
Required |
|
| StateId | integer |
None. |
|
| State_Value | string |
Required |
|
| PostCode | string |
Required |
|
| CountryId | integer |
Required |
|
| Country_Value | string |
None. |
|
| WorkPhoneNumber | string |
None. |
|
| HomePhoneNumber | string |
None. |
|
| IsPrimary | boolean |
None. |
|
| AddressType | string |
None. |
|
| SpecialSafePlace | string |
None. |
|
| IsActive | boolean |
None. |
|
| IsLetterBoxDelivery | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"CustomerId": 2,
"UserType": "sample string 3",
"AddressLine1": "sample string 4",
"AddressLine2": "sample string 5",
"CityId": 1,
"City_Value": "sample string 6",
"StateId": 1,
"State_Value": "sample string 7",
"PostCode": "sample string 8",
"CountryId": 1,
"Country_Value": "sample string 9",
"WorkPhoneNumber": "sample string 10",
"HomePhoneNumber": "sample string 11",
"IsPrimary": true,
"AddressType": "sample string 12",
"SpecialSafePlace": "sample string 13",
"IsActive": true,
"IsLetterBoxDelivery": true
}
application/xml, text/xml
Sample:
<CustomerAddressViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CodaPharma.Api.Models"> <AddressLine1>sample string 4</AddressLine1> <AddressLine2>sample string 5</AddressLine2> <AddressType>sample string 12</AddressType> <CityId>1</CityId> <City_Value>sample string 6</City_Value> <CountryId>1</CountryId> <Country_Value>sample string 9</Country_Value> <CustomerId>2</CustomerId> <HomePhoneNumber>sample string 11</HomePhoneNumber> <Id>1</Id> <IsActive>true</IsActive> <IsLetterBoxDelivery>true</IsLetterBoxDelivery> <IsPrimary>true</IsPrimary> <PostCode>sample string 8</PostCode> <SpecialSafePlace>sample string 13</SpecialSafePlace> <StateId>1</StateId> <State_Value>sample string 7</State_Value> <UserType>sample string 3</UserType> <WorkPhoneNumber>sample string 10</WorkPhoneNumber> </CustomerAddressViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | ResStatus |
None. |
|
| ErrorMessage | string |
None. |
|
| Data | Object |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": 0,
"ErrorMessage": "sample string 1",
"Data": {}
}
application/xml, text/xml
Sample:
<ResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CodaPharma.Api.Models"> <Data /> <ErrorMessage>sample string 1</ErrorMessage> <Status>Fail</Status> </ResponseModel>