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}

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

Query parameters

searchstring

Field for searching random string type data from database

Example: John

filterstring

Field name that user wishes to filter

Example: FirstName

orderingstring

How user wishes to order the data

Example: descending

pageinteger

Result page number

Example: 1

pageSizeinteger

Number of results on one page

Example: 10

query.<fieldName>string

Example of searchable database field. If more searchable fields are in DB, then more similar fields will follow in input

Example: Value can be in any supported format, for an example 'string'

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/data/{registryName}/{versionNumber}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text'

200

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

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Body

queryobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/data/{registryName}/{versionNumber}/read' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text' \
  --header 'Content-Type: application/json' \
  --data '{"query":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}}}'

200

404

200

{
  "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

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Body

queryobject

Search object that needs to be updated

writeobjectrequired

Update found object with the following data

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/data/{registryName}/{versionNumber}/update' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text' \
  --header 'Content-Type: application/json' \
  --data '{"query":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}},"write":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}}}'

200

200

No body

updateEntries

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

put

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

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Body

queryobject

Find objects that needs to be updated

writeobjectrequired

Data that needs to be added to the found objects

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/data/{registryName}/{versionNumber}/updateEntries' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text' \
  --header 'Content-Type: application/json' \
  --data '{"query":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}},"write":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}}}'

200

200

No body

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

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Body

queryobject

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

writeobjectrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/data/{registryName}/{versionNumber}/updateOrCreate' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text' \
  --header 'Content-Type: application/json' \
  --data '{"query":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}},"write":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}}}'

200

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

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Body

queryobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/data/{registryName}/{versionNumber}/exists' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text' \
  --header 'Content-Type: application/json' \
  --data '{"query":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}}}'

200

200

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

delete

Delete record.

delete

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

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

idstringrequired

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

Example: ID1

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/data/{registryName}/{versionNumber}/{id}/delete' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text'

204

204

No body

readValue

Searches and returns one record’s one field value.

get

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

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

uuidstringrequired

Primary key field

Example: DB-1

fieldstringrequired

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

Example: First name

extstringrequired

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

Example: json

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/data/{registryName}/{versionNumber}/{uuid}/readValue/{field}.{ext}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text'

200

200

text

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

get

/data/mypersonalDataUsage

Query parameters

userIdstringrequired

User's personal unique identifier

Example: EE378129277266

databaseIdstringrequired

Database acronym

Example: MCTS

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/data/mypersonalDataUsage?userId=EE378129277266&databaseId=MCTS' \
  --header 'Information-Mediator-Client: text'

200

400

404

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": []
  }
]

Success Response

API endpoint that allows user to get database information with schema

get

/database/{id}

Authorizations

Path parameters

idintegerrequired

Id of the database that schema is requested

Example: 1

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/eregistrations-dev

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/database/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text'

200

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",
    "groupId": 10,
    "order": 76,
    "dataIndexIncrement": 3,
    "databases": [
      {
        "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",
          "groupId": 10,
          "order": 76,
          "dataIndexIncrement": 3,
          "databases": [
            "[Circular Reference]"
          ]
        },
        "isDraft": false,
        "isDisabled": false,
        "isArchived": false,
        "modifiedAt": "2021-10-03T08:35:01.775915Z",
        "byUserName": "ingmar.dev",
        "byUserAuthId": 1,
        "byOnBehalfOfUserAuthId": 0,
        "byOnBehalfOfUserName": null,
        "dataIndexIncrement": 0,
        "hasLogo": false,
        "fieldsUniques": [
          [
            ""
          ]
        ],
        "schemaTags": [
          {
            "name": "",
            "path": "/Child/Citizenship",
            "isFulltext": true
          }
        ],
        "schemaFlags": [
          {
            "name": "mandatory",
            "path": "/ID"
          }
        ],
        "genericServices": [
          {
            "serviceId": 1,
            "name": "data-create",
            "isVisible": true,
            "usedCount": 0
          }
        ]
      }
    ]
  },
  "isDraft": false,
  "isDisabled": false,
  "isArchived": false,
  "modifiedAt": "2021-10-03T08:35:01.775915Z",
  "byUserName": "ingmar.dev",
  "byUserAuthId": 1,
  "byOnBehalfOfUserAuthId": 0,
  "byOnBehalfOfUserName": null,
  "dataIndexIncrement": 0,
  "hasLogo": false,
  "fieldsUniques": [
    [
      ""
    ]
  ],
  "schemaTags": [
    {
      "name": "",
      "path": "/Child/Citizenship",
      "isFulltext": true
    }
  ],
  "schemaFlags": [
    {
      "name": "mandatory",
      "path": "/ID"
    }
  ],
  "genericServices": [
    {
      "serviceId": 1,
      "name": "data-create",
      "isVisible": true,
      "usedCount": 0
    }
  ]
}

API endpoint that allows user to delete database schema

delete

/database/{id}

Authorizations

Path parameters

idintegerrequired

Id of the database that schema is requested

Example: 1

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/eregistrations-dev

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/database/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text'

200

200

Success

Success

API endpoint that allows user to create or modify database schema

post

/database/modify

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/eregistrations-dev

Body

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/database/modify' \
  --header 'Information-Mediator-Client: text' \
  --header 'Content-Type: application/json' \
  --data '{"groupName":"Test","catalogName":"Mother and Child","code":"MCR","schema":{"type":"object","incrementIndex":20,"required":["ID"],"properties":{"child":{"type":"string","properties":{"id":{"type":"string","description":"Child ID","example":"ID2","id":13}}},"ID":{"type":"string","primaryKey":true,"readOnly":true,"description":"Registration ID","example":"MCTS31","id":1,"triggers":[{"conditions":[{"logic":"==","value":"","gate":"&&"}],"actions":[{"type":"set-value","value":"MCTS{indexNoByCode}","field_id":1}]}]}}}}'

200

200

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

Success

API endpoint that allows user to get information about all databases

get

/databases

Authorizations

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/eregistrations-dev

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/databases' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text'

200

200

{
  "id": 85,
  "name": "Mother and Child",
  "code": "MCTS",
  "groupId": 10,
  "order": 76,
  "dataIndexIncrement": 3,
  "databases": [
    {
      "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",
        "groupId": 10,
        "order": 76,
        "dataIndexIncrement": 3,
        "databases": [
          "[Circular Reference]"
        ]
      },
      "isDraft": false,
      "isDisabled": false,
      "isArchived": false,
      "modifiedAt": "2021-10-03T08:35:01.775915Z",
      "byUserName": "ingmar.dev",
      "byUserAuthId": 1,
      "byOnBehalfOfUserAuthId": 0,
      "byOnBehalfOfUserName": null,
      "dataIndexIncrement": 0,
      "hasLogo": false,
      "fieldsUniques": [
        [
          ""
        ]
      ],
      "schemaTags": [
        {
          "name": "",
          "path": "/Child/Citizenship",
          "isFulltext": true
        }
      ],
      "schemaFlags": [
        {
          "name": "mandatory",
          "path": "/ID"
        }
      ],
      "genericServices": [
        {
          "serviceId": 1,
          "name": "data-create",
          "isVisible": true,
          "usedCount": 0
        }
      ]
    }
  ]
}

list

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

get

/data/{registryName}//{versionNumber}

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

Query parameters

searchstring

Field for searching random string type data from database

Example: John

filterstring

Field name that user wishes to filter

Example: FirstName

orderingstring

How user wishes to order the data

Example: descending

pageinteger

Result page number

Example: 1

pageSizeinteger

Number of results on one page

Example: 10

query.<fieldName>string

Example of searchable database field. If more searchable fields are in DB, then more similar fields will follow in input

Example: Value can be in any supported format, for an example 'string'

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/data/{registryName}/{versionNumber}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text'

200

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

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Body

application/x-www-form-urlencodedmultipart/form-dataapplication/json

writeobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/data/mcts/createEntries' \
  --header 'Information-Mediator-Client: text' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"write":[{"content":{},"createdAt":"2025-02-22T14:34:18.168Z","modifiedAt":"2025-02-22T14:34:18.168Z","uuid":"123e4567-e89b-12d3-a456-426614174000"}]}'

201

201

{
  "receive": [
    {
      "createdAt": "2025-02-22T14:34:18.168Z",
      "modifiedAt": "2025-02-22T14:34:18.168Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "content": {
        "id": "MCTS31",
        "start": "2021-10-03T07:03:36Z",
        "expiry": "2021-10-03T07:03:36Z",
        "paymentId": "text",
        "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"
          }
        },
        "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"
        }
      }
    }
  ]
}

read

Searches and returns one record.

post

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

Authorizations

Path parameters

registryNamestringrequired

versionNumberstringrequired

Header parameters

Information-Mediator-Clientstringrequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries

Body

queryobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/data/{registryName}/{versionNumber}/read' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Information-Mediator-Client: text' \
  --header 'Content-Type: application/json' \
  --data '{"query":{"content":{"id":"EE378627348834","firstName":"John Helmut","lastName":"Smith Carry","birthCertificateId":"RR-1234567889"}}}'

200

404

200

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