| POST | /api/UpdateCustomer |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Acct | query | integer | Yes | Customer Acct # |
| LocationId | query | integer | No | Location ID |
| CustomerDefaultId | query | integer | No | Customer Default Id |
| TaxAuthorityId | query | integer | No | Tax Authority Id |
| Name | body | string | No | |
| Attn | body | string | No | |
| Address1 | body | string | No | |
| Address2 | body | string | No | |
| City | body | string | No | |
| State | body | string | No | |
| Zip | body | string | No | |
| Country | body | string | No | |
| HomePhone | body | string | No | |
| WorkPhone | body | string | No | |
| CellPhone | body | string | No | |
| Employer | body | string | No | |
| SS | body | string | No | |
| body | string | No | ||
| EmailMethod | query | string | No | Email Method. Set this to Word, PDF, HTML, or None |
| Notes | body | string | No | |
| DriversLicenseInfo | body | LicenseInfo | No | |
| RefreshCustomerDefaults | query | bool | No | If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default. |
| FormInputList | query | array | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | The Login Token return by the Security API. Required for secured calls. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | string | No | |
| Height | form | string | No | |
| Weight | form | string | No | |
| Hair | form | string | No | |
| Eyes | form | string | No | |
| Expiration | form | string | No | |
| Birthday | form | string | No | |
| Ethnicity | form | string | No | |
| Gender | form | string | No | |
| State | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | body | string | Yes | Field name of the Input Field. If linking to an Attribute, this should match the Tag value. |
| Value | body | string | Yes | Value of the Input Field. |
| Encrypted | body | boolean | No | Whether or not the field is encryped with the C2B encryption key. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/UpdateCustomer HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<OAuthToken>String</OAuthToken>
<Token>String</Token>
<Acct>0</Acct>
<Address1>String</Address1>
<Address2>String</Address2>
<Attn>String</Attn>
<CellPhone>String</CellPhone>
<City>String</City>
<Country>String</Country>
<CustomerDefaultId>0</CustomerDefaultId>
<DriversLicenseInfo>
<Birthday>String</Birthday>
<Ethnicity>String</Ethnicity>
<Expiration>String</Expiration>
<Eyes>String</Eyes>
<Gender>String</Gender>
<Hair>String</Hair>
<Height>String</Height>
<Number>String</Number>
<State>String</State>
<Weight>String</Weight>
</DriversLicenseInfo>
<Email>String</Email>
<EmailMethod>String</EmailMethod>
<Employer>String</Employer>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<HomePhone>String</HomePhone>
<LocationId>0</LocationId>
<Name>String</Name>
<Notes>String</Notes>
<RefreshCustomerDefaults>false</RefreshCustomerDefaults>
<SS>String</SS>
<State>String</State>
<TaxAuthorityId>0</TaxAuthorityId>
<WorkPhone>String</WorkPhone>
<Zip>String</Zip>
</UpdateCustomerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UpdateCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
</UpdateCustomerResponse>