WebAPI

<back to all web services

GetAddress

Retrieves a list of addresses for the given contact id.

The following routes are available for this service:
GET/GetAddress/{AddressId}RESTFUL call with the Contact id in the URI.
Parameters:
NameParameterData TypeRequiredDescription
AddressIdpathintYes

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/GetAddress HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

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

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

<GetAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:AddressLine1>String</d2p1:AddressLine1>
    <d2p1:AddressLine2>String</d2p1:AddressLine2>
    <d2p1:AddressType>String</d2p1:AddressType>
    <d2p1:AddressTypeId>0</d2p1:AddressTypeId>
    <d2p1:City>String</d2p1:City>
    <d2p1:CountryCode>String</d2p1:CountryCode>
    <d2p1:CountyCode>String</d2p1:CountyCode>
    <d2p1:PTCABSCode>String</d2p1:PTCABSCode>
    <d2p1:PostalCode>String</d2p1:PostalCode>
  </Address>
  <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>
</GetAddressResponse>