WebAPI

<back to all web services

GetContact

Retrieves contact information for the given contact id.

The following routes are available for this service:
GET/GetContact/{ContactId}RESTFUL call with Contact ID in the URI
Parameters:
NameParameterData TypeRequiredDescription
ContactIdpathintegerYes

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetContact HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<GetContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <ContactId>0</ContactId>
</GetContact>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:CompanyName>String</d2p1:CompanyName>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:IVRPIN>String</d2p1:IVRPIN>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:MobilePhone>String</d2p1:MobilePhone>
    <d2p1:Phone>String</d2p1:Phone>
    <d2p1:Salutation>String</d2p1:Salutation>
    <d2p1:SecurityAnswer>String</d2p1:SecurityAnswer>
    <d2p1:SecurityQuestionId>0</d2p1:SecurityQuestionId>
    <d2p1:ContactId>0</d2p1:ContactId>
    <d2p1:ContactMethod>String</d2p1:ContactMethod>
    <d2p1:ContactMethodId>0</d2p1:ContactMethodId>
    <d2p1:PrimaryAddressId>0</d2p1:PrimaryAddressId>
  </Contact>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</GetContactResponse>