v1

latestOpenAPI 3.0.12026-07-2351136.6 KB

Get a single registration in full.

Returns a single registration in full from the supplied registration application reference.

get/{subscriber}/{fsa_rn}

Path parameters

subscriberstring required

The local authority or MIS provider name.

fsa_rnstring required

The registration application reference.

Query parameters

local-authoritystring

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

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.