GET api/v1/contact

Get brief details regarding a contact

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		GetRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "sample string 1",
    "Key": "sample string 2"
  },
  "Request": {
    "Email": "sample string 1"
  }
}

application/xml, text/xml

Sample:

<GetContactBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels">
  <Authentication xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Models">
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:Key>sample string 2</d2p1:Key>
  </Authentication>
  <Request>
    <Email>sample string 1</Email>
  </Request>
</GetContactBindingModel>

Response Information

Resource Description

ContactsOutgoingModel

Name	Description	Type	Additional information
Message		MessageModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  }
}

application/xml, text/xml

Sample:

<ContactsOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Models">
    <d2p1:Code>(2 digit code reflecting result of request - 00 is good)</d2p1:Code>
    <d2p1:Description>(Message response in text depending upon request/result of request)</d2p1:Description>
  </Message>
</ContactsOutgoingModel>