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

8.2 Applicant Functions

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

schemaDatabaseSchema (object)

Schema object describing the database

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

generic_Servicesarray 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": {
    "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"
    ]
  },
  "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,
  "generic_Services": [
    {
      "serviceId": 1,
      "name": "data-create",
      "isVisible": true,
      "usedCount": 0
    }
  ],
  "dataIndexIncrement": 0,
  "hasLogo": false
}

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 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 get information about all databases

GET/databases

Authorization

apiKey

Header parameters

Response

200

Body

application/json

any

Request

JavaScriptCurlPython

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