8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Copyright © 2024
The APIs defined here establish a blueprint for how the Building Block will interact with other Building Blocks. Additional APIs may be implemented by the Building Block, but the listed APIs define a minimal set of functionality that should be provided by any implementation of this Building Block.
The GovStack non-functional requirements document provides additional information on how 'adaptors' may be used to translate an existing API to the patterns described here. This section also provides guidance on how candidate products are tested and how GovStack validates a product's API against the API specifications defined here.
The tests for the Digital Registries Building Block can be found in this GitHub repository.
The Digital Registries Building Block may contain multiple registries/databases. The dynamic nature of the database structure requires a standard set of automatically generated APIs for all databases hosted on the platform. The system generates default API method endpoints automatically after each publication of the database schema. A new API service version is generated after each schema publish. Database schema version and API versions are in sync.
The naming convention and structure of the API endpoint are the following:
/{information type}/{registry acronym or code}/{version}/{API method as a name}.
Example 1: /api/data/cr/1.0/create
Example 2: /api/v1/database/modify
Each registry contains a unique set of data and the Building Block enables an Analyst to change the data storage structure/schema on the fly. In the following example API descriptions are generated for one example dataset for the Postpartum Infant Care Program registry, where the Caretaker and infant child are registered and a registration ID is issued.
Digital Registries Building Block is expected to host the following API services for each database hosted on the platform.
The API is built using a representational state transfer (REST) software architectural style and described in Open API 3 standard using YAML (a human-readable data-serialization language). Request and response body is in JSON (lightweight data-interchange format).
Delete record.
ID of the citizen that needs to be deleted from the Registry data query API
"ID1"
Searches and returns one record’s one field value.
Primary key field
"DB-1"
Data format. Endpoint: /data/DB/1.0/DB-1/read-value/First%20name.json
"First name"
Data format. Endpoint: /data/DB/1.0/DB-1/read-value/First%20name.json
"json"
Searches (Regex supported) and returns multiple records as an array-list.
Number of results
1
URI to next results page
1
Searches (Regex supported) and returns multiple records as an array-list.
Number of results
1
URI to next results page
1
Searches and returns one record.
Searches and returns one record.
Allows a user to see who has read their personal data.
Success Response
Log record ID
"1234567"
Identifier of a reader who looked at personal data
"EE37819285773"
Reader's initials
"JD"
Reader's instituition ID
"EE70049837"
Reader's institution name
"East Hospital"
Reader's institution system name
"East Hospital healthcare back office"
Date and time of registration
"2017-07-21T17:32:28Z"
Personal Data reference
Updates one existing record in the registry database.
Search object that needs to be updated
Update found object with the following data
Updates multiple records in the registry database that match the input query.
Find objects that needs to be updated
Data that needs to be added to the found objects
Searches records based on input parameters and returns boolean answer (true/false).
API updates existing record if matching with input parameters is successful. If record is not found the API will create a new record.
Find object to update, if object not found, new will be created
Data that will be updated for found Example object. If object not found new object with this data is created
API endpoint that allows user to delete database schema
Id of the database that schema is requested
1
Success
"Success"
API endpoint that allows user to create or modify database schema
Group name where this schema is located
"Test"
Catalog name where this schema is located
"Mother and Child"
Short code of the database
"MCR"
Success
"object"
20
API endpoint that allows user to get database information with schema
Id of the database that schema is requested
1
Database ID
353
Database version number
"2.7"
Database name
"MCTS"
Database description
"Database holding information about MCTS objects"
Owner of the database (institution)
"Ministry of Social Affairs"
Number format in database
"{code}{indexNoByCode}"
Example of databases API request response body
List of different schema tags that are related to the database
List of different schema flags that are related to the database
Shows database draft status (is draft true/false)
false
Shows if database is disabled or not
false
Shows if database is archived or not
false
Shows database last modification time
"2021-10-03T08:35:01.775915Z"
Shows user name of a person who created the database
"ingmar.dev"
Shows id of a person who created the database
1
Shows user id whose behalf was this database created
0
Shows user name whose behalf was this database created
List of possible API services for this database
Shows database increment
0
Shows if this database has logo or not
false
API endpoint that allows user to get information about all databases
ID of databases
85
Name of databases group
"Mother and Child"
Short name of databases group
"MCTS"
Array of databases schemas
ID of databases group
10
Order number of databases group
76
Data index increment of databases group
3