POST/shorts.v1alpha1.PoliticiansService/ListPoliticianSummaries

ListPoliticianSummaries

Filtered politician summaries for the explorer table.

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

chamberstring

(proto string)

itemNointeger <int32>

0 = all (proto int32)

limitinteger <int32>

(proto int32)

offsetinteger <int32>

(proto int32)

partyAbstring

(proto string)

querystring

(proto string)

sortstring [POLITICIAN_SUMMARY_SORT_DECLARED_ITEMS, POLITICIAN_SUMMARY_SORT_COMPANIES, POLITICIAN_SUMMARY_SORT_PROPERTIES, POLITICIAN_SUMMARY_SORT_RECENT_CHANGES, POLITICIAN_SUMMARY_SORT_NAME]

(proto shorts.v1alpha1.PoliticianSummarySort)

stateCodestring

(proto string)

Responses

200Success

application/json

object

asAtstring <date-time>

(proto google.protobuf.Timestamp)

sourceLicencestring

(proto string)

summariesarray

(proto shorts.v1alpha1.PoliticianSummary)

Array Items:

object

totalinteger <int32>

(proto int32)

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.PoliticiansService/ListPoliticianSummaries" \
  -H "Content-Type: application/json" \
  -d '{
  "chamber": "string",
  "itemNo": 0,
  "limit": 0,
  "offset": 0,
  "partyAb": "string",
  "query": "string",
  "sort": "string",
  "stateCode": "string"
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.PoliticiansService/ListPoliticianSummaries" \
  -H "Content-Type: application/json" \
  -d '{
  "chamber": "string",
  "itemNo": 0,
  "limit": 0,
  "offset": 0,
  "partyAb": "string",
  "query": "string",
  "sort": "string",
  "stateCode": "string"
}'