GET api/Customers/Titles
Retrieves all possible customer titles as setup in the Eskimo system.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of EskimoClassLibraries.clsCustomerTitle| Name | Description | Type | Additional information |
|---|---|---|---|
| TitleID |
The Eskimo-generated ID for this customer title |
integer |
None. |
| TitleValue |
The value of this customer title. i.e. Mr., Mrs., Miss., Dr. etc. |
string |
None. |
| Active |
If the title should be displayed for new customers. Historic inactive ones may still be joined to existing customers. |
boolean |
None. |
| OrderBy | integer |
None. |
|
| FrequentUse | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"TitleID": 1,
"TitleValue": "sample string 2",
"Active": true,
"OrderBy": 4,
"FrequentUse": true
},
{
"TitleID": 1,
"TitleValue": "sample string 2",
"Active": true,
"OrderBy": 4,
"FrequentUse": true
}
]
application/xml, text/xml
Sample:
<ArrayOfclsCustomerTitle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
<clsCustomerTitle>
<Active>true</Active>
<FrequentUse>true</FrequentUse>
<OrderBy>4</OrderBy>
<TitleID>1</TitleID>
<TitleValue>sample string 2</TitleValue>
</clsCustomerTitle>
<clsCustomerTitle>
<Active>true</Active>
<FrequentUse>true</FrequentUse>
<OrderBy>4</OrderBy>
<TitleID>1</TitleID>
<TitleValue>sample string 2</TitleValue>
</clsCustomerTitle>
</ArrayOfclsCustomerTitle>