AIM Web Services

<back to all web services

UpdateCustomerRequest

UpdateCustomer
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/UpdateCustomer
UpdateCustomerRequest Parameters:
NameParameterData TypeRequiredDescription
AcctqueryintegerYesCustomer Acct #
LocationIdqueryintegerNoLocation ID
CustomerDefaultIdqueryintegerNoCustomer Default Id
TaxAuthorityIdqueryintegerNoTax Authority Id
NamebodystringNo
AttnbodystringNo
Address1bodystringNo
Address2bodystringNo
CitybodystringNo
StatebodystringNo
ZipbodystringNo
CountrybodystringNo
HomePhonebodystringNo
WorkPhonebodystringNo
CellPhonebodystringNo
EmployerbodystringNo
SSbodystringNo
EmailbodystringNo
EmailMethodquerystringNoEmail Method. Set this to Word, PDF, HTML, or None
NotesbodystringNo
DriversLicenseInfobodyLicenseInfoNo
RefreshCustomerDefaultsqueryboolNoIf TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default.
FormInputListqueryarrayNo
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
LicenseInfo Parameters:
NameParameterData TypeRequiredDescription
NumberformstringNo
HeightformstringNo
WeightformstringNo
HairformstringNo
EyesformstringNo
ExpirationformstringNo
BirthdayformstringNo
EthnicityformstringNo
GenderformstringNo
StateformstringNo
FormInput Parameters:
NameParameterData TypeRequiredDescription
KeyquerystringYesField Name of the Input Field
ValuequerystringYesValue of the Input Field.
EncryptedquerybooleanYesWhether or not the field is encryped with the C2B encryption key.
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Acct":0,"LocationId":0,"CustomerDefaultId":0,"TaxAuthorityId":0,"Name":"String","Attn":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","HomePhone":"String","WorkPhone":"String","CellPhone":"String","Employer":"String","SS":"String","Email":"String","EmailMethod":"String","Notes":"String","DriversLicenseInfo":{"Number":"String","Height":"String","Weight":"String","Hair":"String","Eyes":"String","Expiration":"String","Birthday":"String","Ethnicity":"String","Gender":"String","State":"String"},"RefreshCustomerDefaults":false,"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}