GET api/Contacts/Lookup

Identifies a contact with the specified telephone number or e-mail address.

Request

Parameters

Name	Description	Default
`type`	Type of look-up to perform.
`value`	Look-up value.

Response

Body

Content Type: application/xml or application/json
Identifiers for a contact, or an error message.

XML JSON
<Response> <Result> <ID>long</ID> <!--Contact number (unique ID)--> <FileAs>string</FileAs> <!--File-as name--> </Result> <Message>string</Message> <!--Error message--> </Response>
{ "Result": { "ID": "long", // Contact number (unique ID) "FileAs": "string" // File-as name }, "Message": "string" // Error message }

XML JSON

<Response>                     
  <Result>                     
    <ID>long</ID>              <!--Contact number (unique ID)--> 
    <FileAs>string</FileAs>    <!--File-as name--> 
  </Result>                    
  <Message>string</Message>    <!--Error message--> 
</Response>

{                          
   "Result": {             
      "ID": "long",        // Contact number (unique ID)
      "FileAs": "string"   // File-as name
   },                      
   "Message": "string"     // Error message
}

Status Codes

Code	Condition
200 OK	The operation completed successfully.
204 No Content	No matching contact was found.
400 Bad Request	Invalid look-up type or look-up value not specified.
401 Unauthorized	Access token is invalid, expired or not specified.
406 Not Acceptable	Content type specified in the Accept header isn't supported.
500 Internal Server Error	An internal error occurred.

Remarks

The look-up type can be one of the following values:

Value	Description
`email`	Look up by e-mail address (case-insensitive match).
`telephone`	Look up by telephone number (prefix match).
`historicalCode`	Look up by historical code (case-insensitive match).