GET v1/PersonalCustomers/{parentEntityID}/AdditionalContacts

Get a list of additional/business contacts for a customer (for 3rd party devs)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
parentEntityID

Id of parent entity

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of contacts

Collection of AdditionalContactDTO
NameDescriptionTypeAdditional information
EntityID

integer

None.

ParentEntityID

integer

None.

PrimaryContact

boolean

None.

FirstName

string

None.

MiddleName

string

None.

LastName

string

None.

DOB

date

None.

MaritalStatusID

byte

None.

Gender

string

None.

MaritalStatus

string

None.

PreferredEmailAddress

string

None.

PreferredPhoneNumber

string

None.

RelationID

integer

None.

Relation

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "EntityID": 1,
    "ParentEntityID": 2,
    "PrimaryContact": true,
    "FirstName": "sample string 4",
    "MiddleName": "sample string 5",
    "LastName": "sample string 6",
    "DOB": "2024-12-13T18:48:45.7277802+00:00",
    "MaritalStatusID": 64,
    "Gender": "sample string 7",
    "MaritalStatus": "sample string 8",
    "PreferredEmailAddress": "sample string 9",
    "PreferredPhoneNumber": "sample string 10",
    "RelationID": 1,
    "Relation": "sample string 11"
  },
  {
    "EntityID": 1,
    "ParentEntityID": 2,
    "PrimaryContact": true,
    "FirstName": "sample string 4",
    "MiddleName": "sample string 5",
    "LastName": "sample string 6",
    "DOB": "2024-12-13T18:48:45.7277802+00:00",
    "MaritalStatusID": 64,
    "Gender": "sample string 7",
    "MaritalStatus": "sample string 8",
    "PreferredEmailAddress": "sample string 9",
    "PreferredPhoneNumber": "sample string 10",
    "RelationID": 1,
    "Relation": "sample string 11"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAdditionalContactDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <AdditionalContactDTO>
    <DOB>2024-12-13T18:48:45.7277802+00:00</DOB>
    <EntityID>1</EntityID>
    <FirstName>sample string 4</FirstName>
    <Gender>sample string 7</Gender>
    <LastName>sample string 6</LastName>
    <MaritalStatus>sample string 8</MaritalStatus>
    <MaritalStatusID>64</MaritalStatusID>
    <MiddleName>sample string 5</MiddleName>
    <ParentEntityID>2</ParentEntityID>
    <PreferredEmailAddress>sample string 9</PreferredEmailAddress>
    <PreferredPhoneNumber>sample string 10</PreferredPhoneNumber>
    <PrimaryContact>true</PrimaryContact>
    <Relation>sample string 11</Relation>
    <RelationID>1</RelationID>
  </AdditionalContactDTO>
  <AdditionalContactDTO>
    <DOB>2024-12-13T18:48:45.7277802+00:00</DOB>
    <EntityID>1</EntityID>
    <FirstName>sample string 4</FirstName>
    <Gender>sample string 7</Gender>
    <LastName>sample string 6</LastName>
    <MaritalStatus>sample string 8</MaritalStatus>
    <MaritalStatusID>64</MaritalStatusID>
    <MiddleName>sample string 5</MiddleName>
    <ParentEntityID>2</ParentEntityID>
    <PreferredEmailAddress>sample string 9</PreferredEmailAddress>
    <PreferredPhoneNumber>sample string 10</PreferredPhoneNumber>
    <PrimaryContact>true</PrimaryContact>
    <Relation>sample string 11</Relation>
    <RelationID>1</RelationID>
  </AdditionalContactDTO>
</ArrayOfAdditionalContactDTO>