8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block.

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.

Example registry database logical data model.

Example registry database Json schema.

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).

8.1 Administrative/Analyst Functions

list

Searches (Regex supported) and returns multiple records as an array-list.

GET/data/{registryName}/{versionNumber}

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

Query parameters

Header parameters

Response

200

Body

application/json

count*integer

Number of results

Example: 1

nextstring (uri)

URI to next results page

Example: 1

previousstring (uri)

results*array of Example (object)

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}', {
    method: 'GET',
    headers: {
      "Information-Mediator-Client": "text"
    },
});
const data = await response.json();

Response

200

{
  "count": 1,
  "next": 1,
  "previous": "https://example.com",
  "results": [
    {
      "id": "EE378627348834",
      "firstName": "John Helmut",
      "lastName": "Smith Carry",
      "birthCertificateId": "RR-1234567889"
    }
  ]
}

read

Searches and returns one record.

POST/data/{registryName}/{versionNumber}/read

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

Header parameters

Body

application/json

query*object

Response

200404

Body

application/json

contentExample (object)

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}/read', {
    method: 'POST',
    headers: {
      "Information-Mediator-Client": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": {
        "content": {}
      }
    }),
});
const data = await response.json();

Response

200404

{
  "content": {
    "id": "EE378627348834",
    "firstName": "John Helmut",
    "lastName": "Smith Carry",
    "birthCertificateId": "RR-1234567889"
  }
}

update

Updates one existing record in the registry database.

PUT/data/{registryName}/{versionNumber}/update

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

Header parameters

Body

application/json

queryobject

Search object that needs to be updated

write*object

Update found object with the following data

Response

200

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}/update', {
    method: 'PUT',
    headers: {
      "Information-Mediator-Client": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "write": {
        "content": {}
      }
    }),
});
const data = await response.json();

updateEntries

Updates multiple records in the registry database that match the input query.

PUT/data/{registryName}/{versionNumber}/updateEntries

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

Header parameters

Body

application/json

queryobject

Find objects that needs to be updated

write*object

Data that needs to be added to the found objects

Response

200

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}/updateEntries', {
    method: 'PUT',
    headers: {
      "Information-Mediator-Client": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "write": {
        "content": {}
      }
    }),
});
const data = await response.json();

update-or-create

API updates existing record if matching with input parameters is successful. If record is not found the API will create a new record.

POST/data/{registryName}/{versionNumber}/updateOrCreate

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

Header parameters

Body

application/json

queryobject

Find object to update, if object not found, new will be created

write*object

Data that will be updated for found Example object. If object not found new object with this data is created

Response

200

Body

application/json

contentExample (object)

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}/updateOrCreate', {
    method: 'POST',
    headers: {
      "Information-Mediator-Client": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "write": {
        "content": {}
      }
    }),
});
const data = await response.json();

Response

200

{
  "content": {
    "id": "EE378627348834",
    "firstName": "John Helmut",
    "lastName": "Smith Carry",
    "birthCertificateId": "RR-1234567889"
  }
}

8.2 Applicant Functions

exists

Searches records based on input parameters and returns boolean answer (true/false).

POST/data/{registryName}/{versionNumber}/exists

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

Header parameters

Body

application/json

query*object

Response

200

Body

application/json

answer*object

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}/exists', {
    method: 'POST',
    headers: {
      "Information-Mediator-Client": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": {
        "content": {}
      }
    }),
});
const data = await response.json();

Response

200

{
  "answer": {
    "status": true,
    "message": "Object found from database"
  }
}

delete

Delete record.

DELETE/data/{registryName}/{versionNumber}/{id}/delete

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

id*string

ID of the citizen that needs to be deleted from the Registry data query API

Example: "ID1"

Header parameters

Response

204

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}/{id}/delete', {
    method: 'DELETE',
    headers: {
      "Information-Mediator-Client": "text"
    },
});
const data = await response.json();

readValue

Searches and returns one record’s one field value.

GET/data/{registryName}/{versionNumber}/{uuid}/readValue/{field}.{ext}

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

uuid*string

Primary key field

Example: "DB-1"

field*string

Data format. Endpoint: /data/DB/1.0/DB-1/read-value/First%20name.json

Example: "First name"

ext*string

Data format. Endpoint: /data/DB/1.0/DB-1/read-value/First%20name.json

Example: "json"

Header parameters

Response

200

Body

application/json

any of

stringobject

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}/{uuid}/readValue/{field}.{ext}', {
    method: 'GET',
    headers: {
      "Information-Mediator-Client": "text"
    },
});
const data = await response.json();

Response

200

text

Allows a user to see who has read their personal data.

GET/data/mypersonalDataUsage

Query parameters

Header parameters

Response

200400404

Success Response

Body

application/json

idstring

Log record ID

Example: "1234567"

readerIdstring

Identifier of a reader who looked at personal data

Example: "EE37819285773"

readerInitialsstring

Reader's initials

Example: "JD"

readerInstitutionIdstring

Reader's instituition ID

Example: "EE70049837"

readerInstitutionNamestring

Reader's institution name

Example: "East Hospital"

readerApplicationNamestring

Reader's institution system name

Example: "East Hospital healthcare back office"

searchDateTimestring (date-time)

Date and time of registration

Example: "2017-07-21T17:32:28Z"

refrencesarray of object

Personal Data reference

Request

JavaScriptCurlPython

const response = await fetch('/data/mypersonalDataUsage?userId=EE378129277266&databaseId=MCTS', {
    method: 'GET',
    headers: {
      "Information-Mediator-Client": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "1234567",
    "readerId": "EE37819285773",
    "readerInitials": "JD",
    "readerInstitutionId": "EE70049837",
    "readerInstitutionName": "East Hospital",
    "readerApplicationName": "East Hospital healthcare back office",
    "searchDateTime": "2017-07-21T17:32:28Z",
    "refrences": [
      {
        "ReferenceId": "MCTS31"
      }
    ]
  }
]

API endpoint that allows user to get database information with schema

GET/database/{id}

Authorization

apiKey

Path parameters

id*integer

Id of the database that schema is requested

Example: 1

Header parameters

Response

200

Body

application/json

idinteger

Database ID

Example: 353

versionstring

Database version number

Example: "2.7"

namestring

Database name

Example: "MCTS"

descriptionstring

Database description

Example: "Database holding information about MCTS objects"

institutionstring

Owner of the database (institution)

Example: "Ministry of Social Affairs"

numberFormatstring

Number format in database

Example: "{code}{indexNoByCode}"

schemadatabasesSchema (object)

Example of databases API request response body

schemaTagsarray of object

List of different schema tags that are related to the database

schemaFlagsarray of object

List of different schema flags that are related to the database

fieldsUniquesarray of array of string

isDraftboolean

Shows database draft status (is draft true/false)

Example: false

isDisabledboolean

Shows if database is disabled or not

Example: false

isArchivedboolean

Shows if database is archived or not

Example: false

modifiedAtstring

Shows database last modification time

Example: "2021-10-03T08:35:01.775915Z"

byUserNamestring

Shows user name of a person who created the database

Example: "ingmar.dev"

byUserAuthIdinteger

Shows id of a person who created the database

Example: 1

byOnBehalfOfUserAuthIdinteger

Shows user id whose behalf was this database created

Example: 0

byOnBehalfOfUserNamestring

Shows user name whose behalf was this database created

genericServicesarray of object

List of possible API services for this database

dataIndexIncrementinteger

Shows database increment

Example: 0

hasLogoboolean

Shows if this database has logo or not

Example: false

Request

JavaScriptCurlPython

const response = await fetch('/database/{id}', {
    method: 'GET',
    headers: {
      "Information-Mediator-Client": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": 353,
  "version": "2.7",
  "name": "MCTS",
  "description": "Database holding information about MCTS objects",
  "institution": "Ministry of Social Affairs",
  "numberFormat": "{code}{indexNoByCode}",
  "schema": {
    "id": 85,
    "name": "Mother and Child",
    "code": "MCTS",
    "databases": [],
    "groupId": 10,
    "order": 76,
    "dataIndexIncrement": 3
  },
  "schemaTags": [
    {
      "name": "",
      "path": "/Child/Citizenship",
      "isFulltext": true
    }
  ],
  "schemaFlags": [
    {
      "name": "mandatory",
      "path": "/ID"
    }
  ],
  "fieldsUniques": [
    [
      ""
    ]
  ],
  "isDraft": false,
  "isDisabled": false,
  "isArchived": false,
  "modifiedAt": "2021-10-03T08:35:01.775915Z",
  "byUserName": "ingmar.dev",
  "byUserAuthId": 1,
  "byOnBehalfOfUserAuthId": 0,
  "byOnBehalfOfUserName": null,
  "genericServices": [
    {
      "serviceId": 1,
      "name": "data-create",
      "isVisible": true,
      "usedCount": 0
    }
  ],
  "dataIndexIncrement": 0,
  "hasLogo": false
}

API endpoint that allows user to delete database schema

DELETE/database/{id}

Authorization

apiKey

Path parameters

id*integer

Id of the database that schema is requested

Example: 1

Header parameters

Response

200

Success

Body

application/json

string

Example: "Success"

Request

JavaScriptCurlPython

const response = await fetch('/database/{id}', {
    method: 'DELETE',
    headers: {
      "Information-Mediator-Client": "text"
    },
});
const data = await response.json();

Response

200

Success

API endpoint that allows user to create or modify database schema

POST/database/modify

Header parameters

Body

application/json

groupNamestring

Group name where this schema is located

Example: "Test"

catalogNamestring

Catalog name where this schema is located

Example: "Mother and Child"

codestring

Short code of the database

Example: "MCR"

schemaall of

Response

200

Success

Body

application/json

typestring

Example: "object"

propertiesobject

incrementIndexinteger

Example: 20

requiredarray of string

Request

JavaScriptCurlPython

const response = await fetch('/database/modify', {
    method: 'POST',
    headers: {
      "Information-Mediator-Client": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "type": "object",
  "properties": {
    "ID": {
      "type": "string",
      "triggers": [
        {
          "conditions": [
            {
              "logic": "==",
              "value": "",
              "gate": "&&"
            }
          ],
          "actions": [
            {
              "type": "set-value",
              "value": "MCTS{indexNoByCode}",
              "field_id": 1
            }
          ]
        }
      ],
      "primaryKey": true,
      "readOnly": true,
      "description": "Registration ID",
      "example": "MCTS31",
      "id": 1
    },
    "child": {
      "type": "string",
      "properties": {
        "id": {
          "type": "string",
          "description": "Child ID",
          "example": "ID2",
          "id": 13
        }
      }
    }
  },
  "incrementIndex": 20,
  "required": [
    "ID"
  ]
}

API endpoint that allows user to get information about all databases

GET/databases

Authorization

apiKey

Header parameters

Response

200

Body

application/json

idinteger

ID of databases

Example: 85

namestring

Name of databases group

Example: "Mother and Child"

codestring

Short name of databases group

Example: "MCTS"

databasesarray of databaseInfo (object)

Array of databases schemas

groupIdinteger

ID of databases group

Example: 10

orderinteger

Order number of databases group

Example: 76

dataIndexIncrementinteger

Data index increment of databases group

Example: 3

Request

JavaScriptCurlPython

const response = await fetch('/databases', {
    method: 'GET',
    headers: {
      "Information-Mediator-Client": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": 85,
  "name": "Mother and Child",
  "code": "MCTS",
  "databases": [
    {
      "id": 353,
      "version": "2.7",
      "name": "MCTS",
      "description": "Database holding information about MCTS objects",
      "institution": "Ministry of Social Affairs",
      "numberFormat": "{code}{indexNoByCode}",
      "schemaTags": [
        {
          "name": "",
          "path": "/Child/Citizenship",
          "isFulltext": true
        }
      ],
      "schemaFlags": [
        {
          "name": "mandatory",
          "path": "/ID"
        }
      ],
      "fieldsUniques": [
        [
          ""
        ]
      ],
      "isDraft": false,
      "isDisabled": false,
      "isArchived": false,
      "modifiedAt": "2021-10-03T08:35:01.775915Z",
      "byUserName": "ingmar.dev",
      "byUserAuthId": 1,
      "byOnBehalfOfUserAuthId": 0,
      "byOnBehalfOfUserName": null,
      "genericServices": [
        {
          "serviceId": 1,
          "name": "data-create",
          "isVisible": true,
          "usedCount": 0
        }
      ],
      "dataIndexIncrement": 0,
      "hasLogo": false
    }
  ],
  "groupId": 10,
  "order": 76,
  "dataIndexIncrement": 3
}

list

Searches (Regex supported) and returns multiple records as an array-list.

GET/data/{registryName}/{versionNumber}

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

Query parameters

Header parameters

Response

200

Body

application/json

count*integer

Number of results

Example: 1

nextstring (uri)

URI to next results page

Example: 1

previousstring (uri)

results*array of Example (object)

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}', {
    method: 'GET',
    headers: {
      "Information-Mediator-Client": "text"
    },
});
const data = await response.json();

Response

200

{
  "count": 1,
  "next": 1,
  "previous": "https://example.com",
  "results": [
    {
      "id": "EE378627348834",
      "firstName": "John Helmut",
      "lastName": "Smith Carry",
      "birthCertificateId": "RR-1234567889"
    }
  ]
}

POST/data/mcts/createEntries

Header parameters

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

write*array of object

Response

201

Body

application/json

receive*array of object

Request

JavaScriptCurlPython

const response = await fetch('/data/mcts/createEntries', {
    method: 'POST',
    headers: {
      "Information-Mediator-Client": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "write": [
        {
          "content": {},
          "createdAt": "2024-11-05T10:44:02.269Z",
          "modifiedAt": "2024-11-05T10:44:02.269Z",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }),
});
const data = await response.json();

Response

201

{
  "receive": [
    {
      "content": {
        "id": "MCTS31",
        "start": "2021-10-03T07:03:36Z",
        "expiry": "2021-10-03T07:03:36Z",
        "child": {
          "citizenId": "ID2",
          "firstName": "Usha",
          "lastNames": "Bajaj",
          "birthdate": "2021-10-03T07:03:36Z",
          "address": "Longroad 123, Welltown, Ethiopia",
          "nationality": "ET",
          "birthCertificate": {
            "url": "text",
            "originalName": "text",
            "type": "text"
          },
          "gender": "Male"
        },
        "caretaker": {
          "citizenId": "ID1",
          "firstName": "Sowmya",
          "lastNames": "Bajaj",
          "birthdate": "2021-10-03T07:03:36Z",
          "phone": "[phone]",
          "email": "[e-mail]",
          "picture": {
            "url": "text",
            "originalName": "text",
            "type": "text"
          },
          "citizenIdDoc": {
            "url": "text",
            "originalName": "text",
            "type": "text"
          }
        },
        "paymentId": "text"
      },
      "createdAt": "2024-11-05T10:44:02.269Z",
      "modifiedAt": "2024-11-05T10:44:02.269Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

read

Searches and returns one record.

POST/data/{registryName}/{versionNumber}/read

Authorization

apiKey

Path parameters

registryName*string

versionNumber*string

Header parameters

Body

application/json

query*object

Response

200404

Body

application/json

contentExample (object)

Request

JavaScriptCurlPython

const response = await fetch('/data/{registryName}/{versionNumber}/read', {
    method: 'POST',
    headers: {
      "Information-Mediator-Client": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": {
        "content": {}
      }
    }),
});
const data = await response.json();

Response

200404

{
  "content": {
    "id": "EE378627348834",
    "firstName": "John Helmut",
    "lastName": "Smith Carry",
    "birthCertificateId": "RR-1234567889"
  }
}