POST/shorts.v1alpha1.HousingService/GetSuburbIndex

GetSuburbIndex

Stable sal_code-ordered index used by all columnar suburb responses.

Parameters

Connect-Protocol-VersionheaderRequired

number [1]

Define the version of the Connect protocol

Connect-Timeout-Msheader

number

Define the timeout, in ms

Request Body

application/json

object

The stable identity/label spine for one state's columnar suburb data. Entries are always ordered lexically by sal_code, never by display name.

stateCodestring

'NSW' | 'VIC' | ... (required) (proto string)

Responses

200Success

application/json

object

indexVersionstring

Short v1 SHA-256 prefix derived only from the sorted sal_code set. (proto string)

suburbsarray

(proto shorts.v1alpha1.SuburbIndexEntry)

Array Items:

object

defaultError

application/json

object

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

codestring [canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, unauthenticated]

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

detailsarray

A list of messages that carry the error details. There is no limit on the number of messages.

Array Items:

object

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.HousingService/GetSuburbIndex" \
  -H "Content-Type: application/json" \
  -d '{
  "stateCode": "string"
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.HousingService/GetSuburbIndex" \
  -H "Content-Type: application/json" \
  -d '{
  "stateCode": "string"
}'