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

"use strict";
export class SuburbModel {
    /** @param {{SuburbId?:string,Name?:string,StateId?:string,StateName?:string,PostCode?:string,CountryId?:string,CountryName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SuburbId;
    /** @type {string} */
    Name;
    /** @type {string} */
    StateId;
    /** @type {string} */
    StateName;
    /** @type {string} */
    PostCode;
    /** @type {string} */
    CountryId;
    /** @type {string} */
    CountryName;
}
export class GetSuburbsResponse {
    /** @param {{Suburbs?:SuburbModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SuburbModel[]} */
    Suburbs;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetSuburbs {
    /** @param {{SearchText?:string,StateName?:string,PostCode?:string,CountryId?:string,CountryName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Get suburbs matching the specified search text criteria. */
    SearchText;
    /**
     * @type {string}
     * @description State to get suburbs for */
    StateName;
    /**
     * @type {string}
     * @description Postcode to get suburbs for */
    PostCode;
    /**
     * @type {string}
     * @description Country to get suburbs for */
    CountryId;
    /**
     * @type {string}
     * @description Country to get suburbs for */
    CountryName;
}

JavaScript 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
		}
	}
}