POST/shorts.v1alpha1.PoliticiansService/ListTopDonors

ListTopDonors

Payers into party branches for one financial year, ordered by the total they were declared to have paid.

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

financialYearstring

empty = latest year held (proto string)

limitinteger <int32>

default 50, max 200 (proto int32)

offsetinteger <int32>

(proto int32)

partyGroupstring

empty = every party group (proto string)

Responses

200Success

application/json

object

asAtstring <date-time>

(proto google.protobuf.Timestamp)

attributionstring

(proto string)

censoringNotestring

(proto string)

donorsarray

(proto shorts.v1alpha1.TopDonor)

Array Items:

object

TopDonor is one payer's itemised receipts into party branches for one financial year. donor_name is VERBATIM as lodged — the source is unnormalised and one entity can appear under several spellings. donor_name_norm is the key those spellings were grouped by, published so a reader can see exactly what was combined.

financialYearstring

(proto string)

partyGroupstring

(proto string)

reformNotestring

(proto string)

scopeNotestring

What this list is over, stated rather than assumed: itemised receipts whose recipient is a party branch that rolls up to a party group. Receipts into associated entities and third parties that never lodged a party return belong to no group and are not counted here. (proto string)

sourceLicencestring

(proto string)

totalinteger <int32>

Distinct payers matching the filters, NOT the page size — a surface states the real population rather than the rows it happens to have rendered. (proto int32)

verbatimNotestring

(proto string)

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/ListTopDonors" \
  -H "Content-Type: application/json" \
  -d '{
  "financialYear": "string",
  "limit": 0,
  "offset": 0,
  "partyGroup": "string"
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.PoliticiansService/ListTopDonors" \
  -H "Content-Type: application/json" \
  -d '{
  "financialYear": "string",
  "limit": 0,
  "offset": 0,
  "partyGroup": "string"
}'