GET v1/Contacts/{contactId}/ContactSummaryDTO
Gets contact summary info for a single contact
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactId |
The Id of the contact |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Contact summary
ContactSummaryDTOName | Description | Type | Additional information |
---|---|---|---|
isAPerson | boolean |
None. |
|
CreatedOn | string |
None. |
|
HasBeenModified | boolean |
None. |
|
DOB | date |
None. |
|
MaritalStatusID | byte |
None. |
|
EntityID | integer |
None. |
|
DisplayName | string |
None. |
|
TypeDisplay | string |
None. |
|
ContactSubTypeDisplay | string |
None. |
|
AgentName | string |
None. |
|
StatusDisplay | string |
None. |
|
ContactTypeDisplay | string |
None. |
|
PhoneType | string |
None. |
|
PrimaryContact | string |
None. |
|
DateLastModified | date |
None. |
|
CustomerNo | string |
None. |
|
ContactSubType | string |
None. |
|
FirstName | string |
None. |
|
MiddleName | string |
None. |
|
LastName | string |
None. |
|
Phone | string |
None. |
|
string |
None. |
||
Line1 | string |
None. |
|
Line2 | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
County | string |
None. |
|
Zip | string |
None. |
|
Country | string |
None. |
|
LocationID | integer |
None. |
|
Status | string |
None. |
|
ContactType | string |
None. |
|
BusinessName | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "isAPerson": true, "CreatedOn": "sample string 1", "HasBeenModified": true, "DOB": "2024-12-13T17:34:41.7800315+00:00", "MaritalStatusID": 64, "EntityID": 1, "DisplayName": "sample string 2", "TypeDisplay": "sample string 3", "ContactSubTypeDisplay": "sample string 4", "AgentName": "sample string 5", "StatusDisplay": "sample string 6", "ContactTypeDisplay": "sample string 7", "PhoneType": "sample string 8", "PrimaryContact": "sample string 9", "DateLastModified": "2024-12-13T17:34:41.7800315+00:00", "CustomerNo": "sample string 10", "ContactSubType": "sample string 11", "FirstName": "sample string 12", "MiddleName": "sample string 13", "LastName": "sample string 14", "Phone": "sample string 15", "Email": "sample string 16", "Line1": "sample string 17", "Line2": "sample string 18", "City": "sample string 19", "State": "sample string 20", "County": "sample string 21", "Zip": "sample string 22", "Country": "sample string 23", "LocationID": 1, "Status": "sample string 24", "ContactType": "sample string 25", "BusinessName": "sample string 26" }
application/xml, text/xml
Sample:
<ContactSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts"> <BusinessName>sample string 26</BusinessName> <City>sample string 19</City> <ContactSubType>sample string 11</ContactSubType> <ContactType>sample string 25</ContactType> <Country>sample string 23</Country> <County>sample string 21</County> <CustomerNo>sample string 10</CustomerNo> <Email>sample string 16</Email> <FirstName>sample string 12</FirstName> <LastName>sample string 14</LastName> <Line1>sample string 17</Line1> <Line2>sample string 18</Line2> <LocationID>1</LocationID> <MiddleName>sample string 13</MiddleName> <Phone>sample string 15</Phone> <State>sample string 20</State> <Status>sample string 24</Status> <Zip>sample string 22</Zip> <AgentName>sample string 5</AgentName> <ContactSubTypeDisplay>sample string 4</ContactSubTypeDisplay> <ContactTypeDisplay>sample string 7</ContactTypeDisplay> <DateLastModified>2024-12-13T17:34:41.7800315+00:00</DateLastModified> <DisplayName>sample string 2</DisplayName> <EntityID>1</EntityID> <PhoneType>sample string 8</PhoneType> <PrimaryContact>sample string 9</PrimaryContact> <StatusDisplay>sample string 6</StatusDisplay> <TypeDisplay>sample string 3</TypeDisplay> <CreatedOn>sample string 1</CreatedOn> <DOB>2024-12-13T17:34:41.7800315+00:00</DOB> <HasBeenModified>true</HasBeenModified> <MaritalStatusID>64</MaritalStatusID> <isAPerson>true</isAPerson> </ContactSummaryDTO>