Sign in

v1

latestOpenAPI 3.0.12026-07-2351136.6 KB

Get registrations for local authority or MIS provider.

Returns registrations for the supplied local authority or MIS provider. By default, results are filtered to exclude data marked as collected.

get/{subscriber}

Path parameters

subscriberstring required

The local authority or MIS provider name.

Query parameters

local-authoritiesstring[]

The local authorities for which to return data, if different to the organisation supplied in the subscriber parameter.

fieldsstring[]

Extra fields to return as part of the response.

afterstring

Format - date-time (as date-time in RFC3339). Filter registrations to those created/updated after an ISO formatted UTC date-time e.g. 2019-04-29T16:01:12Z.

beforestring

Format - date-time (as date-time in RFC3339). Filter registrations to those created/updated before an ISO formatted UTC date-time e.g. 2019-04-30T16:01:12Z.

newtrue | false

Filter registrations to those not yet marked as collected.

Response

OK.

fsa_rnstring

The unique registration application reference that identifies this registration.

councilstring

The full name of the local authority.

competent_authority_idinteger

The unique id for the local authority.

local_council_urlstring

The unique url for the local authority.

collectedboolean

Flag indicating whether this registration has been collected by the local authority or not.

collected_atstring

The date and time that the registration was collected.

createdAtstring

The date and time that the registration was created.

updatedAtstring

The date and time that the registration was updated.