GET v1/Customers/{customerID}/CustomerDetailSummary
Get a detail summary of information about a customer (for 3rd party devs)
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerID |
Id of the customer |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Customer detail summary
CustomerDetailSummaryDTOName | Description | Type | Additional information |
---|---|---|---|
EntityID | integer |
None. |
|
IsPerson | integer |
None. |
|
FirstName | string |
None. |
|
MiddleName | string |
None. |
|
LastName | string |
None. |
|
DOB | date |
None. |
|
MaritalStatusID | byte |
None. |
|
MaritalStatus | string |
None. |
|
Gender | string |
None. |
|
BusinessName | string |
None. |
|
LocationID | integer |
None. |
|
CustomerSourceID | integer |
None. |
|
EntityStatus | string |
None. |
|
SourceDetail | string |
None. |
|
CustomerSTatus | string |
None. |
|
Prospect | boolean |
None. |
|
CustomerNo | string |
None. |
|
CustomerSince | date |
None. |
|
AgentID | integer |
None. |
|
AgentName | string |
None. |
|
CSRID | integer |
None. |
|
CSRName | string |
None. |
|
Type | string |
None. |
|
PreferredLanguageCode | integer |
None. |
|
DisplayName | string |
None. |
|
Salutation | string |
None. |
|
SSN | string |
None. |
|
DriverLicenseNo | string |
None. |
|
FEIN | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "EntityID": 1, "IsPerson": 2, "FirstName": "sample string 3", "MiddleName": "sample string 4", "LastName": "sample string 5", "DOB": "2024-11-21T06:47:56.5494591+00:00", "MaritalStatusID": 64, "MaritalStatus": "sample string 6", "Gender": "sample string 7", "BusinessName": "sample string 8", "LocationID": 9, "CustomerSourceID": 1, "EntityStatus": "sample string 10", "SourceDetail": "sample string 11", "CustomerSTatus": "sample string 12", "Prospect": true, "CustomerNo": "sample string 14", "CustomerSince": "2024-11-21T06:47:56.5494591+00:00", "AgentID": 1, "AgentName": "sample string 16", "CSRID": 1, "CSRName": "sample string 17", "Type": "sample string 18", "PreferredLanguageCode": 1, "DisplayName": "sample string 19", "Salutation": "sample string 20", "SSN": "sample string 21", "DriverLicenseNo": "sample string 22", "FEIN": "sample string 23" }
application/xml, text/xml
Sample:
<CustomerDetailSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts"> <AgentID>1</AgentID> <AgentName>sample string 16</AgentName> <BusinessName>sample string 8</BusinessName> <CSRID>1</CSRID> <CSRName>sample string 17</CSRName> <CustomerNo>sample string 14</CustomerNo> <CustomerSTatus>sample string 12</CustomerSTatus> <CustomerSince>2024-11-21T06:47:56.5494591+00:00</CustomerSince> <CustomerSourceID>1</CustomerSourceID> <DOB>2024-11-21T06:47:56.5494591+00:00</DOB> <DisplayName>sample string 19</DisplayName> <DriverLicenseNo>sample string 22</DriverLicenseNo> <EntityID>1</EntityID> <EntityStatus>sample string 10</EntityStatus> <FEIN>sample string 23</FEIN> <FirstName>sample string 3</FirstName> <Gender>sample string 7</Gender> <IsPerson>2</IsPerson> <LastName>sample string 5</LastName> <LocationID>9</LocationID> <MaritalStatus>sample string 6</MaritalStatus> <MaritalStatusID>64</MaritalStatusID> <MiddleName>sample string 4</MiddleName> <PreferredLanguageCode>1</PreferredLanguageCode> <Prospect>true</Prospect> <SSN>sample string 21</SSN> <Salutation>sample string 20</Salutation> <SourceDetail>sample string 11</SourceDetail> <Type>sample string 18</Type> </CustomerDetailSummaryDTO>