1 of 1

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.

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

8 Service APIs

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

The tests for the Digital Registries Building Block can be found in this GitHub repository.

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

Digital Registries Building Block is expected to host the following API services for each database hosted on the platform.

8.1 Administrative/Analyst Functions

8.2 Applicant Functions

API endpoint that allows user to get database information with schema

GET/database/{id}

Authorization

Path parameters

id*integer

Id of the database that schema is requested

Example: 1

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/eregistrations-dev"

Response

Body

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

typestring

Example: "object"

propertiesobject

IDobject

typestring

Example: "string"

triggersarray of object

conditionsarray of object

logicstring

Example: "=="

valuestring

Example: ""

gatestring

Example: "&&"

actionsarray of object

typestring

Example: "set-value"

valuestring

Example: "MCTS{indexNoByCode}"

field_idinteger

Example: 1

primaryKeyboolean

Example: true

readOnlyboolean

Example: true

descriptionstring

Example: "Registration ID"

examplestring

Example: "MCTS31"

idinteger

Example: 1

childobject

typestring

Example: "string"

propertiesobject

idobject

typestring

Example: "string"

descriptionstring

Example: "Child ID"

examplestring

Example: "ID2"

idinteger

Example: 13

incrementIndexinteger

Example: 20

requiredarray of string

itemsstring

Example: "ID"

schemaTagsarray of object

List of different schema tags that are related to the database

namestring

Example: ""

pathstring

Example: "/Child/Citizenship"

isFulltextboolean

Example: true

schemaFlagsarray of object

List of different schema flags that are related to the database

namestring

Example: "mandatory"

pathstring

Example: "/ID"

fieldsUniquesarray of array of string

itemsstring

Example: ""

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

serviceIdinteger

Example: 1

namestring

Example: "data-create"

isVisibleboolean

Example: true

usedCountinteger

Example: 0

dataIndexIncrementinteger

Shows database increment

Example: 0

hasLogoboolean

Shows if this database has logo or not

Example: false

Request

Response

API endpoint that allows user to create or modify database schema

POST/database/modify

Header parameters

Information-Mediator-Client*string

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

typestring

Example: "object"

propertiesobject

IDobject

typestring

Example: "string"

triggersarray of object

conditionsarray of object

logicstring

Example: "=="

valuestring

Example: ""

gatestring

Example: "&&"

actionsarray of object

typestring

Example: "set-value"

valuestring

Example: "MCTS{indexNoByCode}"

field_idinteger

Example: 1

primaryKeyboolean

Example: true

readOnlyboolean

Example: true

descriptionstring

Example: "Registration ID"

examplestring

Example: "MCTS31"

idinteger

Example: 1

childobject

typestring

Example: "string"

propertiesobject

idobject

typestring

Example: "string"

descriptionstring

Example: "Child ID"

examplestring

Example: "ID2"

idinteger

Example: 13

incrementIndexinteger

Example: 20

requiredarray of string

itemsstring

Example: "ID"

Response

Success

Body

typestring

Example: "object"

propertiesobject

IDobject

typestring

Example: "string"

triggersarray of object

conditionsarray of object

logicstring

Example: "=="

valuestring

Example: ""

gatestring

Example: "&&"

actionsarray of object

typestring

Example: "set-value"

valuestring

Example: "MCTS{indexNoByCode}"

field_idinteger

Example: 1

primaryKeyboolean

Example: true

readOnlyboolean

Example: true

descriptionstring

Example: "Registration ID"

examplestring

Example: "MCTS31"

idinteger

Example: 1

childobject

typestring

Example: "string"

propertiesobject

idobject

typestring

Example: "string"

descriptionstring

Example: "Child ID"

examplestring

Example: "ID2"

idinteger

Example: 13

incrementIndexinteger

Example: 20

requiredarray of string

itemsstring

Example: "ID"

Request

Response

API endpoint that allows user to delete database schema

DELETE/database/{id}

Authorization

Path parameters

id*integer

Id of the database that schema is requested

Example: 1

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/eregistrations-dev"

Response

Success

Body

string

Example: "Success"

Request

Response

API endpoint that allows user to get information about all databases

GET/databases

Authorization

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/eregistrations-dev"

Response

Body

any

Request

API endpoint that allows user to delete database schema

DELETE/database/{id}

Authorization

Path parameters

id*integer

Id of the database that schema is requested

Example: 1

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/eregistrations-dev"

Response

Success

Body

string

Example: "Success"

Request

Response

API endpoint that allows user to create or modify database schema

POST/database/modify

Header parameters

Information-Mediator-Client*string

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

typestring

Example: "object"

propertiesobject

IDobject

typestring

Example: "string"

triggersarray of object

conditionsarray of object

logicstring

Example: "=="

valuestring

Example: ""

gatestring

Example: "&&"

actionsarray of object

typestring

Example: "set-value"

valuestring

Example: "MCTS{indexNoByCode}"

field_idinteger

Example: 1

primaryKeyboolean

Example: true

readOnlyboolean

Example: true

descriptionstring

Example: "Registration ID"

examplestring

Example: "MCTS31"

idinteger

Example: 1

childobject

typestring

Example: "string"

propertiesobject

idobject

typestring

Example: "string"

descriptionstring

Example: "Child ID"

examplestring

Example: "ID2"

idinteger

Example: 13

incrementIndexinteger

Example: 20

requiredarray of string

itemsstring

Example: "ID"

Response

Success

Body

typestring

Example: "object"

propertiesobject

IDobject

typestring

Example: "string"

triggersarray of object

conditionsarray of object

logicstring

Example: "=="

valuestring

Example: ""

gatestring

Example: "&&"

actionsarray of object

typestring

Example: "set-value"

valuestring

Example: "MCTS{indexNoByCode}"

field_idinteger

Example: 1

primaryKeyboolean

Example: true

readOnlyboolean

Example: true

descriptionstring

Example: "Registration ID"

examplestring

Example: "MCTS31"

idinteger

Example: 1

childobject

typestring

Example: "string"

propertiesobject

idobject

typestring

Example: "string"

descriptionstring

Example: "Child ID"

examplestring

Example: "ID2"

idinteger

Example: 13

incrementIndexinteger

Example: 20

requiredarray of string

itemsstring

Example: "ID"

Request

Response

API endpoint that allows user to get database information with schema

GET/database/{id}

Authorization

Path parameters

id*integer

Id of the database that schema is requested

Example: 1

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/eregistrations-dev"

Response

Body

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

typestring

Example: "object"

propertiesobject

IDobject

typestring

Example: "string"

triggersarray of object

conditionsarray of object

logicstring

Example: "=="

valuestring

Example: ""

gatestring

Example: "&&"

actionsarray of object

typestring

Example: "set-value"

valuestring

Example: "MCTS{indexNoByCode}"

field_idinteger

Example: 1

primaryKeyboolean

Example: true

readOnlyboolean

Example: true

descriptionstring

Example: "Registration ID"

examplestring

Example: "MCTS31"

idinteger

Example: 1

childobject

typestring

Example: "string"

propertiesobject

idobject

typestring

Example: "string"

descriptionstring

Example: "Child ID"

examplestring

Example: "ID2"

idinteger

Example: 13

incrementIndexinteger

Example: 20

requiredarray of string

itemsstring

Example: "ID"

schemaTagsarray of object

List of different schema tags that are related to the database

namestring

Example: ""

pathstring

Example: "/Child/Citizenship"

isFulltextboolean

Example: true

schemaFlagsarray of object

List of different schema flags that are related to the database

namestring

Example: "mandatory"

pathstring

Example: "/ID"

fieldsUniquesarray of array of string

itemsstring

Example: ""

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

serviceIdinteger

Example: 1

namestring

Example: "data-create"

isVisibleboolean

Example: true

usedCountinteger

Example: 0

dataIndexIncrementinteger

Shows database increment

Example: 0

hasLogoboolean

Shows if this database has logo or not

Example: false

Request

Response

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

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