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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class SuburbModel
    {
        public virtual Guid SuburbId { get; set; }
        public virtual string Name { get; set; }
        public virtual Guid StateId { get; set; }
        public virtual string StateName { get; set; }
        public virtual string PostCode { get; set; }
        public virtual Guid CountryId { get; set; }
        public virtual string CountryName { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get all suburbs for the specified country, state and/or postcode
    ///</summary>
    [Api(Description="Get all suburbs for the specified country, state and/or postcode")]
    public partial class GetSuburbs
    {
        ///<summary>
        ///Get suburbs matching the specified search text criteria.
        ///</summary>
        [ApiMember(Description="Get suburbs matching the specified search text criteria.", Name="SearchText")]
        public virtual string SearchText { get; set; }

        ///<summary>
        ///State to get suburbs for
        ///</summary>
        [ApiMember(Description="State to get suburbs for", Name="StateName")]
        public virtual string StateName { get; set; }

        ///<summary>
        ///Postcode to get suburbs for
        ///</summary>
        [ApiMember(Description="Postcode to get suburbs for", Name="Postcode")]
        public virtual string PostCode { get; set; }

        ///<summary>
        ///Country to get suburbs for
        ///</summary>
        [ApiMember(Description="Country to get suburbs for", Name="CountryId")]
        public virtual Guid CountryId { get; set; }

        ///<summary>
        ///Country to get suburbs for
        ///</summary>
        [ApiMember(Description="Country to get suburbs for", Name="CountryName")]
        public virtual string CountryName { get; set; }
    }

    [ApiResponse(Description="List of suburbs matching the criteria")]
    public partial class GetSuburbsResponse
    {
        public virtual List<SuburbModel> Suburbs { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetSuburbs DTOs

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>