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 'package:servicestack/servicestack.dart';

class SuburbModel implements IConvertible
{
    String? SuburbId;
    String? Name;
    String? StateId;
    String? StateName;
    String? PostCode;
    String? CountryId;
    String? CountryName;

    SuburbModel({this.SuburbId,this.Name,this.StateId,this.StateName,this.PostCode,this.CountryId,this.CountryName});
    SuburbModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SuburbId = json['SuburbId'];
        Name = json['Name'];
        StateId = json['StateId'];
        StateName = json['StateName'];
        PostCode = json['PostCode'];
        CountryId = json['CountryId'];
        CountryName = json['CountryName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SuburbId': SuburbId,
        'Name': Name,
        'StateId': StateId,
        'StateName': StateName,
        'PostCode': PostCode,
        'CountryId': CountryId,
        'CountryName': CountryName
    };

    getTypeName() => "SuburbModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="List of suburbs matching the criteria")
class GetSuburbsResponse implements IConvertible
{
    List<SuburbModel>? Suburbs;
    ResponseStatus? ResponseStatus;

    GetSuburbsResponse({this.Suburbs,this.ResponseStatus});
    GetSuburbsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Suburbs = JsonConverters.fromJson(json['Suburbs'],'List<SuburbModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Suburbs': JsonConverters.toJson(Suburbs,'List<SuburbModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetSuburbsResponse";
    TypeContext? context = _ctx;
}

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

    /**
    * State to get suburbs for
    */
    // @ApiMember(Description="State to get suburbs for", Name="StateName")
    String? StateName;

    /**
    * Postcode to get suburbs for
    */
    // @ApiMember(Description="Postcode to get suburbs for", Name="Postcode")
    String? PostCode;

    /**
    * Country to get suburbs for
    */
    // @ApiMember(Description="Country to get suburbs for", Name="CountryId")
    String? CountryId;

    /**
    * Country to get suburbs for
    */
    // @ApiMember(Description="Country to get suburbs for", Name="CountryName")
    String? CountryName;

    GetSuburbs({this.SearchText,this.StateName,this.PostCode,this.CountryId,this.CountryName});
    GetSuburbs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SearchText = json['SearchText'];
        StateName = json['StateName'];
        PostCode = json['PostCode'];
        CountryId = json['CountryId'];
        CountryName = json['CountryName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SearchText': SearchText,
        'StateName': StateName,
        'PostCode': PostCode,
        'CountryId': CountryId,
        'CountryName': CountryName
    };

    getTypeName() => "GetSuburbs";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SuburbModel': TypeInfo(TypeOf.Class, create:() => SuburbModel()),
    'GetSuburbsResponse': TypeInfo(TypeOf.Class, create:() => GetSuburbsResponse()),
    'List<SuburbModel>': TypeInfo(TypeOf.Class, create:() => <SuburbModel>[]),
    'GetSuburbs': TypeInfo(TypeOf.Class, create:() => GetSuburbs()),
});

Dart GetSuburbs DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}