GET api/clients/{clientId}/contacts

Gets the contacts for a client. This includes contacts that don't have an address

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

The client ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

The contacts

Collection of StandaloneContact
NameDescriptionTypeAdditional information
AddressTypeCode

The address type code of the address that this contact is associated with. May be null if the contact is associated with multiple addresses or no addresses.

string

None.

ID

Gets or sets the ID that represents this contact.

integer

None.

ReferenceId

Gets or sets a reference ID to help us accurately determine whether this contact's entry is the same as another contact in a different address from the same Get Client request. If you modify the details of one instance of a contact, you should update all of them because there's no guarantee about which instancewill be saved. There is no guarantee that this ID will match between different calls.

string

None.

ContactType

Gets or sets a string that describes the type of contact this is.

string

None.

FirstName

Gets or sets the first name of the person that this contact information belongs to.

string

None.

LastName

Gets or sets the last name of the person that this contact information belongs to.

string

None.

Comments

The comments on the contact, if any

string

None.

Details

Gets or sets the details of how to contact this person.

Collection of ContactDetail

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "addressTypeCode": "sample string 1",
    "id": 2,
    "referenceId": "sample string 3",
    "contactType": "sample string 4",
    "firstName": "sample string 5",
    "lastName": "sample string 6",
    "comments": "sample string 7",
    "details": [
      {
        "id": 1,
        "contactString": "sample string 2",
        "type": {
          "code": "sample string 1",
          "name": "sample string 2",
          "type": 0
        },
        "isPreferred": true
      },
      {
        "id": 1,
        "contactString": "sample string 2",
        "type": {
          "code": "sample string 1",
          "name": "sample string 2",
          "type": 0
        },
        "isPreferred": true
      }
    ]
  },
  {
    "addressTypeCode": "sample string 1",
    "id": 2,
    "referenceId": "sample string 3",
    "contactType": "sample string 4",
    "firstName": "sample string 5",
    "lastName": "sample string 6",
    "comments": "sample string 7",
    "details": [
      {
        "id": 1,
        "contactString": "sample string 2",
        "type": {
          "code": "sample string 1",
          "name": "sample string 2",
          "type": 0
        },
        "isPreferred": true
      },
      {
        "id": 1,
        "contactString": "sample string 2",
        "type": {
          "code": "sample string 1",
          "name": "sample string 2",
          "type": 0
        },
        "isPreferred": true
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfStandaloneContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <StandaloneContact>
    <Comments>sample string 7</Comments>
    <ContactType>sample string 4</ContactType>
    <Details>
      <ContactDetail>
        <ContactString>sample string 2</ContactString>
        <ID>1</ID>
        <Type>
          <Code>sample string 1</Code>
          <Name>sample string 2</Name>
          <Type>Phone</Type>
        </Type>
      </ContactDetail>
      <ContactDetail>
        <ContactString>sample string 2</ContactString>
        <ID>1</ID>
        <Type>
          <Code>sample string 1</Code>
          <Name>sample string 2</Name>
          <Type>Phone</Type>
        </Type>
      </ContactDetail>
    </Details>
    <FirstName>sample string 5</FirstName>
    <ID>2</ID>
    <LastName>sample string 6</LastName>
    <ReferenceId>sample string 3</ReferenceId>
    <AddressTypeCode>sample string 1</AddressTypeCode>
  </StandaloneContact>
  <StandaloneContact>
    <Comments>sample string 7</Comments>
    <ContactType>sample string 4</ContactType>
    <Details>
      <ContactDetail>
        <ContactString>sample string 2</ContactString>
        <ID>1</ID>
        <Type>
          <Code>sample string 1</Code>
          <Name>sample string 2</Name>
          <Type>Phone</Type>
        </Type>
      </ContactDetail>
      <ContactDetail>
        <ContactString>sample string 2</ContactString>
        <ID>1</ID>
        <Type>
          <Code>sample string 1</Code>
          <Name>sample string 2</Name>
          <Type>Phone</Type>
        </Type>
      </ContactDetail>
    </Details>
    <FirstName>sample string 5</FirstName>
    <ID>2</ID>
    <LastName>sample string 6</LastName>
    <ReferenceId>sample string 3</ReferenceId>
    <AddressTypeCode>sample string 1</AddressTypeCode>
  </StandaloneContact>
</ArrayOfStandaloneContact>