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

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SuburbModel() = 
        member val SuburbId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val StateId:Guid = new Guid() with get,set
        member val StateName:String = null with get,set
        member val PostCode:String = null with get,set
        member val CountryId:Guid = new Guid() with get,set
        member val CountryName:String = null with get,set

    [<ApiResponse(Description="List of suburbs matching the criteria")>]
    [<AllowNullLiteral>]
    type GetSuburbsResponse() = 
        member val Suburbs:ResizeArray<SuburbModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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")>]
    [<AllowNullLiteral>]
    type GetSuburbs() = 
        ///<summary>
        ///Get suburbs matching the specified search text criteria.
        ///</summary>
        [<ApiMember(Description="Get suburbs matching the specified search text criteria.", Name="SearchText")>]
        member val SearchText:String = null with get,set

        ///<summary>
        ///State to get suburbs for
        ///</summary>
        [<ApiMember(Description="State to get suburbs for", Name="StateName")>]
        member val StateName:String = null with get,set

        ///<summary>
        ///Postcode to get suburbs for
        ///</summary>
        [<ApiMember(Description="Postcode to get suburbs for", Name="Postcode")>]
        member val PostCode:String = null with get,set

        ///<summary>
        ///Country to get suburbs for
        ///</summary>
        [<ApiMember(Description="Country to get suburbs for", Name="CountryId")>]
        member val CountryId:Guid = new Guid() with get,set

        ///<summary>
        ///Country to get suburbs for
        ///</summary>
        [<ApiMember(Description="Country to get suburbs for", Name="CountryName")>]
        member val CountryName:String = null with get,set

F# GetSuburbs DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

{
	SearchText: String,
	StateName: String,
	PostCode: String,
	CountryName: String
}

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

{
	Suburbs: 
	[
		{
			Name: String,
			StateName: String,
			PostCode: String,
			CountryName: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}