GET api/clients/{clientId}/contacts/preferred?useFallbackContact={useFallbackContact}

Gets the details of a client's preferred contact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

The client ID.

 integer

Required
useFallbackContact

Use the fallback contact details or not

 boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Returns their preferred contact.

PreferredContact
NameDescriptionTypeAdditional information
FirstName

The contact's first name.

 string

None.
LastName

The contact's last name.

 string

None.
PhoneNumber

The phone number that this person prefers to be contacted by.

 string

None.
Email

The email address that this person prefers to be contacted by.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "firstName": "sample string 1",
  "lastName": "sample string 2",
  "phoneNumber": "sample string 3",
  "email": "sample string 4"
}

application/xml, text/xml

Sample: 
<PreferredContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <Email>sample string 4</Email>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <PhoneNumber>sample string 3</PhoneNumber>
</PreferredContact>