POST api/Partner/SetAddress
Request Information
URI Parameters
None.
Body Parameters
SetAddressRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Address | Address |
None. |
|
| Token | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Address": {
"AddressId": "sample string 1",
"UserId": "sample string 2",
"UserAddressCompanyTypeId": 64,
"Description": "sample string 4",
"CompanyTitle": "sample string 5",
"ContactTitle": "sample string 6",
"Email": "sample string 7",
"PhoneNumber": "sample string 8",
"Website": "sample string 9",
"Fax": "sample string 10",
"TaxAuthority": "sample string 11",
"TaxNumber": "sample string 12",
"AddressLine1": "sample string 13",
"AddressLine2": "sample string 14",
"Neighborhood": "sample string 15",
"District": "sample string 16",
"City": "sample string 17",
"PostalCode": "sample string 18",
"Country": "sample string 19"
},
"Token": "sample string 1"
}
application/xml, text/xml
Sample:
<SetAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Account.Request">
<Token xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 1</Token>
<Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Account">
<d2p1:AddressId>sample string 1</d2p1:AddressId>
<d2p1:AddressLine1>sample string 13</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 14</d2p1:AddressLine2>
<d2p1:City>sample string 17</d2p1:City>
<d2p1:CompanyTitle>sample string 5</d2p1:CompanyTitle>
<d2p1:ContactTitle>sample string 6</d2p1:ContactTitle>
<d2p1:Country>sample string 19</d2p1:Country>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:District>sample string 16</d2p1:District>
<d2p1:Email>sample string 7</d2p1:Email>
<d2p1:Fax>sample string 10</d2p1:Fax>
<d2p1:Neighborhood>sample string 15</d2p1:Neighborhood>
<d2p1:PhoneNumber>sample string 8</d2p1:PhoneNumber>
<d2p1:PostalCode>sample string 18</d2p1:PostalCode>
<d2p1:TaxAuthority>sample string 11</d2p1:TaxAuthority>
<d2p1:TaxNumber>sample string 12</d2p1:TaxNumber>
<d2p1:UserAddressCompanyTypeId>64</d2p1:UserAddressCompanyTypeId>
<d2p1:UserId>sample string 2</d2p1:UserId>
<d2p1:Website>sample string 9</d2p1:Website>
</Address>
</SetAddressRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SetAddressResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Address | Address |
None. |
|
| ErrorCode | string |
None. |
|
| ErrorMessage | string |
None. |
|
| ErrorCategory | string |
None. |
|
| Result | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Address": {
"AddressId": "sample string 1",
"UserId": "sample string 2",
"UserAddressCompanyTypeId": 64,
"Description": "sample string 4",
"CompanyTitle": "sample string 5",
"ContactTitle": "sample string 6",
"Email": "sample string 7",
"PhoneNumber": "sample string 8",
"Website": "sample string 9",
"Fax": "sample string 10",
"TaxAuthority": "sample string 11",
"TaxNumber": "sample string 12",
"AddressLine1": "sample string 13",
"AddressLine2": "sample string 14",
"Neighborhood": "sample string 15",
"District": "sample string 16",
"City": "sample string 17",
"PostalCode": "sample string 18",
"Country": "sample string 19"
},
"ErrorCode": "sample string 1",
"ErrorMessage": "sample string 2",
"ErrorCategory": "sample string 3",
"Result": true
}
application/xml, text/xml
Sample:
<SetAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Account.Response">
<ErrorCategory xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 3</ErrorCategory>
<ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 1</ErrorCode>
<ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 2</ErrorMessage>
<Result xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">true</Result>
<Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Account">
<d2p1:AddressId>sample string 1</d2p1:AddressId>
<d2p1:AddressLine1>sample string 13</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 14</d2p1:AddressLine2>
<d2p1:City>sample string 17</d2p1:City>
<d2p1:CompanyTitle>sample string 5</d2p1:CompanyTitle>
<d2p1:ContactTitle>sample string 6</d2p1:ContactTitle>
<d2p1:Country>sample string 19</d2p1:Country>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:District>sample string 16</d2p1:District>
<d2p1:Email>sample string 7</d2p1:Email>
<d2p1:Fax>sample string 10</d2p1:Fax>
<d2p1:Neighborhood>sample string 15</d2p1:Neighborhood>
<d2p1:PhoneNumber>sample string 8</d2p1:PhoneNumber>
<d2p1:PostalCode>sample string 18</d2p1:PostalCode>
<d2p1:TaxAuthority>sample string 11</d2p1:TaxAuthority>
<d2p1:TaxNumber>sample string 12</d2p1:TaxNumber>
<d2p1:UserAddressCompanyTypeId>64</d2p1:UserAddressCompanyTypeId>
<d2p1:UserId>sample string 2</d2p1:UserId>
<d2p1:Website>sample string 9</d2p1:Website>
</Address>
</SetAddressResponse>