PUT api/Customer/LoadCustomerFromBody
Loads a customer based on an object with parameters passed in the body of the request. If a parameter is not being used none it can be left blank or as 0 for numbers, CheckExists is a boolean and must always have either a true or false value.
Request Information
URI Parameters
None.
Body Parameters
The object to be passed in the body of the request containing the search parameters, parameters handled are as follows: Email - Customer's Email Address PostCode - Customer's Postode LastName - Customer's LastName ID - Customer's ID Password - Customer's Password MemberNumber - Customer's Member Number UserName - Customer's UserName CheckExists - If set to true this will simply check if the customer exists, meaning only an information response will be returned and not a full customer object. SerialNumber - Use this to pass a thankQ serial number to check the contact in Gamma, if this is passed with any other parameter it will first check Gamma otherwise if it is sent along it will check only thankQ and create the contact in Gamma if found.
CustomerLoadParamsName | Description | Type | Additional information |
---|---|---|---|
string |
None. |
||
PostCode | string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
ID | integer |
None. |
|
Password | string |
None. |
|
MemberNumber | string |
None. |
|
UserName | string |
None. |
|
CheckExists | boolean |
None. |
|
SerialNumber | string |
None. |
Request Formats
application/json, text/json
{ "Email": "sample string 1", "PostCode": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "ID": 5, "Password": "sample string 6", "MemberNumber": "sample string 7", "UserName": "sample string 8", "CheckExists": true, "SerialNumber": "sample string 10" }
application/xml, text/xml
<CustomerLoadParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Email>sample string 1</Email> <PostCode>sample string 2</PostCode> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <ID>5</ID> <Password>sample string 6</Password> <MemberNumber>sample string 7</MemberNumber> <UserName>sample string 8</UserName> <CheckExists>true</CheckExists> <SerialNumber>sample string 10</SerialNumber> </CustomerLoadParams>
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |
Response Formats
application/json, text/json
{"ID":0,"Email":"","UDF":"","Title":"","Firstname":"","Middlename":"","Lastname":"","DOB":"0001-01-01T00:00:00","CompanyName":"","HouseNo":"","AddressLine1":"","AddressLine2":"","AddressLine3":"","City":"","Postcode":"","County":"","Country":"","TelephoneNumber":"","EveningTelephoneNumber":"","MailingList":"","Notes":"","Password":"","Interests":null,"PersonImage":"","DDAcountHolder":"","DDAccountNumber":"","DDSortCode":"","DDBankName":"","DDBankAddress":"","DDBankPostCode":"","MemberNumber":"","AccountRef":"","ConsentMail":false,"ConsentPhone":false,"ConsentSMS":false,"ConsentEmail":false,"Username":"","ForcePasswordChange":false,"CustomerRef":"","CustomerUDFs":null}
application/xml, text/xml
<?xml version="1.0" encoding="utf-16"?> <Customer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ID>0</ID> <Email /> <UDF /> <Title /> <Firstname /> <Middlename /> <Lastname /> <DOB>0001-01-01T00:00:00</DOB> <CompanyName /> <HouseNo /> <AddressLine1 /> <AddressLine2 /> <AddressLine3 /> <City /> <Postcode /> <County /> <Country /> <TelephoneNumber /> <EveningTelephoneNumber /> <MailingList /> <Notes /> <Password /> <PersonImage /> <DDAcountHolder /> <DDAccountNumber /> <DDSortCode /> <DDBankName /> <DDBankAddress /> <DDBankPostCode /> <MemberNumber /> <AccountRef /> <ConsentMail>false</ConsentMail> <ConsentPhone>false</ConsentPhone> <ConsentSMS>false</ConsentSMS> <ConsentEmail>false</ConsentEmail> <Username /> <ForcePasswordChange>false</ForcePasswordChange> <CustomerRef /> </Customer>