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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get all suburbs for the specified country, state and/or postcode
*/
@Api(Description="Get all suburbs for the specified country, state and/or postcode")
open class GetSuburbs
{
    /**
    * Get suburbs matching the specified search text criteria.
    */
    @ApiMember(Description="Get suburbs matching the specified search text criteria.", Name="SearchText")
    open var SearchText:String? = null

    /**
    * State to get suburbs for
    */
    @ApiMember(Description="State to get suburbs for", Name="StateName")
    open var StateName:String? = null

    /**
    * Postcode to get suburbs for
    */
    @ApiMember(Description="Postcode to get suburbs for", Name="Postcode")
    open var PostCode:String? = null

    /**
    * Country to get suburbs for
    */
    @ApiMember(Description="Country to get suburbs for", Name="CountryId")
    open var CountryId:UUID? = null

    /**
    * Country to get suburbs for
    */
    @ApiMember(Description="Country to get suburbs for", Name="CountryName")
    open var CountryName:String? = null
}

@ApiResponse(Description="List of suburbs matching the criteria")
open class GetSuburbsResponse
{
    open var Suburbs:ArrayList<SuburbModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class SuburbModel
{
    open var SuburbId:UUID? = null
    open var Name:String? = null
    open var StateId:UUID? = null
    open var StateName:String? = null
    open var PostCode:String? = null
    open var CountryId:UUID? = null
    open var CountryName:String? = null
}

Kotlin 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"}}}