Birth-registration API example
Illustrative exampleSource OpenAPI · Download OpenAPI
Technical metadata
{
"openapi": "3.1.2",
"operations": [
{
"method": "get",
"path": "/health",
"operationId": "getHealth"
},
{
"method": "get",
"path": "/.well-known/api-catalog",
"operationId": "getApiCatalog"
},
{
"method": "head",
"path": "/.well-known/api-catalog",
"operationId": "headApiCatalog"
},
{
"method": "get",
"path": "/v1/collections/birth-registrations/records/{recordId}",
"operationId": "retrieveBirthRegistration",
"x-govstack-pii": true,
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/birth-registrations",
"collection": "birth-registrations",
"capability": "retrieve",
"view": "birth-registration-with-recorded-parents",
"features": [
"recorded-time",
"effective-time",
"purpose-bound"
],
"purpose": {
"required": true,
"binding": "access-token-claim",
"claim": "purpose",
"allowedPurposes": [
"benefit-eligibility"
]
}
}
},
{
"method": "post",
"path": "/v1/collections/birth-registrations/search",
"operationId": "searchBirthRegistrations",
"x-govstack-pii": true,
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/birth-registrations",
"collection": "birth-registrations",
"capability": "search",
"view": "birth-registration-with-recorded-parents",
"features": [
"recorded-time",
"effective-time",
"purpose-bound"
],
"purpose": {
"required": true,
"binding": "access-token-claim",
"claim": "purpose",
"allowedPurposes": [
"benefit-eligibility"
]
}
}
},
{
"method": "get",
"path": "/v1/collections/birth-registrations/records/{recordId}/revisions",
"operationId": "listBirthRegistrationRevisions",
"x-govstack-pii": true,
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/birth-registrations",
"collection": "birth-registrations",
"capability": "revision-list",
"view": "birth-registration-history",
"features": [
"purpose-bound"
],
"purpose": {
"required": true,
"binding": "access-token-claim",
"claim": "purpose",
"allowedPurposes": [
"benefit-eligibility"
]
}
}
},
{
"method": "get",
"path": "/v1/collections/birth-registrations/records/{recordId}/revisions/{revisionId}",
"operationId": "retrieveBirthRegistrationRevision",
"x-govstack-pii": true,
"x-govstack-digital-registries": {
"registry": "https://registry.example/registries/birth-registrations",
"collection": "birth-registrations",
"capability": "revision-retrieve",
"view": "birth-registration-history",
"features": [
"purpose-bound"
],
"purpose": {
"required": true,
"binding": "access-token-claim",
"claim": "purpose",
"allowedPurposes": [
"benefit-eligibility"
]
}
}
}
]
}Unofficial preview · 3.0.0-alpha.2 · Source revision 2350fdf8.
Content snapshot 5e66af7b9724.