GET api/Contacts/{id}/Name

Retrieves the formatted name for a contact.

Request

Parameters

Name	Description	Default
`id`	Contact number (unique ID).
`format`	Desired format for the name.	`ShortName`

Response

Body

Content Type: application/xml or application/json
Formatted contact name or an error message.

XML JSON
<Response> <Result>string</Result> <!--Formatted contact name--> <Message>string</Message> <!--Error message--> </Response>
{ "Result": "string", // Formatted contact name "Message": "string" // Error message }

XML JSON

<Response>                     
  <Result>string</Result>      <!--Formatted contact name--> 
  <Message>string</Message>    <!--Error message--> 
</Response>

{                         
   "Result": "string",    // Formatted contact name
   "Message": "string"    // Error message
}

Status Codes

Code	Condition
200 OK	The operation completed successfully.
400 Bad Request	Invalid contact number.
401 Unauthorized	Access token is invalid, expired or not specified.
404 Not Found	Contact not found.
406 Not Acceptable	Content type specified in the Accept header isn't supported.
500 Internal Server Error	An internal error occurred.

Remarks

The name format can be one of the following values:

Value	Description
`ShortName`	First and last names separated by a space (file-as name for entities).
`CommunicationsName`	First initial and last name separated by a space (abbreviated name for entities).
`PostingName`	Title, initials and last name separated by spaces (trading name for entities).
`FullName`	First, middle and last names separated by spaces (registered entity name for entities).
`FullNameAndTitle`	Title, first/middle/last names and suffix separated by spaces.
`AssociateName`	First and last names separated by spaces, followed by associated entity in brackets (file-as name for entities).
`CommsNameWithParent`	First initial and last name separated by a space, followed by associated entity in brackets (abbreviated name for entities).
`Initials`	All initials without spaces.
`EntityOrParent`	Associated entity or empty (file-as name for entities).
`LastName`	Last name (file-as name for entities).
`ShortOrAbbreviatedName`	First and last names separated by a space (abbreviated name for entities).
`ABN`	Australian Business Number (ABN) of the contact or associated entity.
`ACN`	Australian Company Number (ACN) of the contact or associated entity.
`AltCaptionName`	Last and first names, separated by a comma and a space (file-as name for entities).