| All Verbs | /api/suburbs |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SuburbModel:
suburb_id: Optional[str] = None
name: Optional[str] = None
state_id: Optional[str] = None
state_name: Optional[str] = None
post_code: Optional[str] = None
country_id: Optional[str] = None
country_name: Optional[str] = None
# @ApiResponse(Description="List of suburbs matching the criteria")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSuburbsResponse:
suburbs: Optional[List[SuburbModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get all suburbs for the specified country, state and/or postcode")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSuburbs:
"""
Get all suburbs for the specified country, state and/or postcode
"""
# @ApiMember(Description="Get suburbs matching the specified search text criteria.", Name="SearchText")
search_text: Optional[str] = None
"""
Get suburbs matching the specified search text criteria.
"""
# @ApiMember(Description="State to get suburbs for", Name="StateName")
state_name: Optional[str] = None
"""
State to get suburbs for
"""
# @ApiMember(Description="Postcode to get suburbs for", Name="Postcode")
post_code: Optional[str] = None
"""
Postcode to get suburbs for
"""
# @ApiMember(Description="Country to get suburbs for", Name="CountryId")
country_id: Optional[str] = None
"""
Country to get suburbs for
"""
# @ApiMember(Description="Country to get suburbs for", Name="CountryName")
country_name: Optional[str] = None
"""
Country to get suburbs for
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}