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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"SearchText":"String","StateName":"String","PostCode":"String","CountryId":"00000000-0000-0000-0000-000000000000","CountryName":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Suburbs":[{"SuburbId":"00000000-0000-0000-0000-000000000000","Name":"String","StateId":"00000000-0000-0000-0000-000000000000","StateName":"String","PostCode":"String","CountryId":"00000000-0000-0000-0000-000000000000","CountryName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}