Pera Administrators Service

<back to all web services

GetContactsRequest

The following routes are available for this service:
GET/v2/Contacts

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/GetContactsRequest HTTP/1.1 
Host: api.peraadministrators.com 
Content-Type: application/xml
Content-Length: length

<GetContactsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraAdministrators.API.Internal">
  <AgentId>0</AgentId>
  <City>String</City>
  <ContactStatusId>0</ContactStatusId>
  <ContactTypeId>Employee</ContactTypeId>
  <CreatedAfter>0001-01-01T00:00:00</CreatedAfter>
  <CreatedBefore>0001-01-01T00:00:00</CreatedBefore>
  <EmployedBy>String</EmployedBy>
  <FilterText>String</FilterText>
  <Location>String</Location>
  <Page>0</Page>
  <PageSize>0</PageSize>
  <PlanAttached>false</PlanAttached>
  <SourceTypeId>0</SourceTypeId>
  <State>String</State>
  <Tags>String</Tags>
</GetContactsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetContactsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraAdministrators.API.Internal">
  <Contacts i:nil="true" />
  <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>
</GetContactsResponse>