GET Api/Suburb/List/{postcode}

Request Information

URI Parameters

Name	Description	Type	Additional information
postcode		string	Required

Body Parameters

None.

Response Information

Resource Description

ResultOfSuburbData

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
ErrorMessage	Collection of string	None.
Value	SuburbData	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "SuburbList": [
      {
        "Suburb": "sample string 1"
      },
      {
        "Suburb": "sample string 1"
      }
    ],
    "StateCode": "sample string 1",
    "PostCode": "sample string 2",
    "Total": 3
  }
}

application/xml, text/xml

Sample:

<ResultOfSuburbData6i3i_PuhT xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Common.Returns">
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewPostCodes.Returns">
    <d2p1:PostCode>sample string 2</d2p1:PostCode>
    <d2p1:StateCode>sample string 1</d2p1:StateCode>
    <d2p1:SuburbList xmlns:d3p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewPostCodes.Objects">
      <d3p1:SuburbObject>
        <d3p1:Suburb>sample string 1</d3p1:Suburb>
      </d3p1:SuburbObject>
      <d3p1:SuburbObject>
        <d3p1:Suburb>sample string 1</d3p1:Suburb>
      </d3p1:SuburbObject>
    </d2p1:SuburbList>
    <d2p1:Total>3</d2p1:Total>
  </Value>
</ResultOfSuburbData6i3i_PuhT>