Platform API

GetSuburbs

Get all suburbs for the specified country, state and/or postcode

The following routes are available for this service:
All Verbs	/api/suburbs

**GetSuburbs** Parameters:
Name	Parameter	Data Type	Required	Description
SearchText	query	string	No	Get suburbs matching the specified search text criteria.
StateName	query	string	No	State to get suburbs for
PostCode	query	string	No	Postcode to get suburbs for
CountryId	query	Guid	No	Country to get suburbs for
CountryName	query	string	No	Country to get suburbs for

**GetSuburbsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Suburbs	form	List<SuburbModel>	No
ResponseStatus	form	ResponseStatus	No

**SuburbModel** Parameters:
Name	Parameter	Data Type	Required
SuburbId	form	Guid	No
Name	form	string	No
StateId	form	Guid	No
StateName	form	string	No
PostCode	form	string	No
CountryId	form	Guid	No
CountryName	form	string	No

To override the Content-type in your clients, use the 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 /api/suburbs HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSuburbs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <CountryId>00000000-0000-0000-0000-000000000000</CountryId>
  <CountryName>String</CountryName>
  <PostCode>String</PostCode>
  <SearchText>String</SearchText>
  <StateName>String</StateName>
</GetSuburbs>

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

<GetSuburbsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <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:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Suburbs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:SuburbModel>
      <d2p1:CountryId>00000000-0000-0000-0000-000000000000</d2p1:CountryId>
      <d2p1:CountryName>String</d2p1:CountryName>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PostCode>String</d2p1:PostCode>
      <d2p1:StateId>00000000-0000-0000-0000-000000000000</d2p1:StateId>
      <d2p1:StateName>String</d2p1:StateName>
      <d2p1:SuburbId>00000000-0000-0000-0000-000000000000</d2p1:SuburbId>
    </d2p1:SuburbModel>
  </Suburbs>
</GetSuburbsResponse>