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 none it can be left blank or as 0 for numbers
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.
CustomerLoadParams| Name | Description | Type | Additional information |
|---|---|---|---|
| string |
None. |
||
| PostCode | 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",
"LastName": "sample string 3",
"ID": 4,
"Password": "sample string 5",
"MemberNumber": "sample string 6",
"UserName": "sample string 7",
"CheckExists": true,
"SerialNumber": "sample string 9"
}
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> <LastName>sample string 3</LastName> <ID>4</ID> <Password>sample string 5</Password> <MemberNumber>sample string 6</MemberNumber> <UserName>sample string 7</UserName> <CheckExists>true</CheckExists> <SerialNumber>sample string 9</SerialNumber> </CustomerLoadParams>
Response Information
Resource Description
HttpResponseMessage| Name | 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":""}
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>