POST api/Customer/UpdateSettings
Update settings for a customer
Request Information
URI Parameters
None.
Body Parameters
CustomerSettingsUpdateRequestModelName | Description | Type | Additional information |
---|---|---|---|
CustomerID | integer |
None. |
|
CompanyName | string |
None. |
|
CurrencyID | integer |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
Phone | string |
None. |
|
Address1 | string |
None. |
|
Address2 | string |
None. |
|
CountryID | integer |
None. |
|
StateID | integer |
None. |
|
CityID | integer |
None. |
|
ZipCode | string |
None. |
|
ShiptoAddress1 | string |
None. |
|
ShiptoAddress2 | string |
None. |
|
ShiptoCountryID | integer |
None. |
|
ShiptoStateID | integer |
None. |
|
ShiptoCityID | integer |
None. |
|
ShiptoZipCode | string |
None. |
|
APIKey | string |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "customerID": 1, "companyName": "sample string 2", "currencyID": 3, "firstName": "sample string 4", "lastName": "sample string 5", "phone": "sample string 6", "address1": "sample string 7", "address2": "sample string 8", "countryID": 9, "stateID": 10, "cityID": 11, "zipCode": "sample string 12", "shiptoAddress1": "sample string 13", "shiptoAddress2": "sample string 14", "shiptoCountryID": 15, "shiptoStateID": 16, "shiptoCityID": 17, "shiptoZipCode": "sample string 18", "apiKey": "sample string 19" }
application/xml, text/xml
Sample:
<CustomerSettingsUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"> <APIKey>sample string 19</APIKey> <Address1>sample string 7</Address1> <Address2>sample string 8</Address2> <CityID>11</CityID> <CompanyName>sample string 2</CompanyName> <CountryID>9</CountryID> <CurrencyID>3</CurrencyID> <CustomerID>1</CustomerID> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Phone>sample string 6</Phone> <ShiptoAddress1>sample string 13</ShiptoAddress1> <ShiptoAddress2>sample string 14</ShiptoAddress2> <ShiptoCityID>17</ShiptoCityID> <ShiptoCountryID>15</ShiptoCountryID> <ShiptoStateID>16</ShiptoStateID> <ShiptoZipCode>sample string 18</ShiptoZipCode> <StateID>10</StateID> <ZipCode>sample string 12</ZipCode> </CustomerSettingsUpdateRequestModel>
multipart/form-data
Sample:
<CustomerSettingsUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><APIKey>sample string 19</APIKey><Address1>sample string 7</Address1><Address2>sample string 8</Address2><CityID>11</CityID><CompanyName>sample string 2</CompanyName><CountryID>9</CountryID><CurrencyID>3</CurrencyID><CustomerID>1</CustomerID><FirstName>sample string 4</FirstName><LastName>sample string 5</LastName><Phone>sample string 6</Phone><ShiptoAddress1>sample string 13</ShiptoAddress1><ShiptoAddress2>sample string 14</ShiptoAddress2><ShiptoCityID>17</ShiptoCityID><ShiptoCountryID>15</ShiptoCountryID><ShiptoStateID>16</ShiptoStateID><ShiptoZipCode>sample string 18</ShiptoZipCode><StateID>10</StateID><ZipCode>sample string 12</ZipCode></CustomerSettingsUpdateRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CommonResponseDataModelName | Description | Type | Additional information |
---|---|---|---|
ReturnID | integer |
Required |
|
Message | string |
Required |
|
Successful | boolean |
Required |
|
Code | integer |
None. |
|
TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{ "returnID": 1, "message": "sample string 2", "successful": true, "code": 4, "totalRecord": 5 }
application/xml, text/xml
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"> <Code>4</Code> <Message>sample string 2</Message> <ReturnID>1</ReturnID> <Successful>true</Successful> <TotalRecord>5</TotalRecord> </CommonResponseDataModel>
multipart/form-data
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>