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

list

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

GET/data/{registryName}/{versionNumber}

Authorization

Path parameters

registryName*string

versionNumber*string

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-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Body

count*integer

Number of results

Example: 1

nextstring (uri)

URI to next results page

Example: 1

previousstring (uri)

results*array of Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

Response

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

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

query*object

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Body

contentExample (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

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

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

queryobject

Search object that needs to be updated

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

write*object

Update found object with the following data

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Request

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

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

queryobject

Find objects that needs to be updated

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

write*object

Data that needs to be added to the found objects

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Request

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

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

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

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

write*object

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

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Body

contentExample (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

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

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

query*object

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Body

answer*object

status*boolean

Example object found in database

Example: true

messagestring

More information about the object

Example: "Object found from database"

Request

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

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

delete

Delete record.

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

Authorization

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

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Request

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

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

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Body

any of

string

Request

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

Response

text

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

GET/data/mypersonalDataUsage

Query parameters

userId*string

User's personal unique identifier

Example: "EE378129277266"

databaseId*string

Database acronym

Example: "MCTS"

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Success Response

Body

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

ReferenceIdstring

Registration ID

Example: "MCTS31"

Request

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

Response

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

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

schemadatabasesSchema (object)

Example of databases API request response body

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

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

Circular reference to databasesSchema (object) ↩

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

genericServicesarray 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

groupIdinteger

ID of databases group

Example: 10

orderinteger

Order number of databases group

Example: 76

dataIndexIncrementinteger

Data index increment of databases group

Example: 3

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

genericServicesarray 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 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 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

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

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

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

Circular reference to array of databaseInfo (object) ↩

groupIdinteger

ID of databases group

Example: 10

orderinteger

Order number of databases group

Example: 76

dataIndexIncrementinteger

Data index increment of databases group

Example: 3

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

genericServicesarray 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

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

Response

list

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

GET/data/{registryName}/{versionNumber}

Authorization

Path parameters

registryName*string

versionNumber*string

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-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Body

count*integer

Number of results

Example: 1

nextstring (uri)

URI to next results page

Example: 1

previousstring (uri)

results*array of Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

Response

{
  "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-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

write*array of object

content*object

idstring

Registration ID

Example: "MCTS31"

startstring (date)

Record registration date

Example: "2021-10-03T07:03:36Z"

expirystring (date)

Record expiry date

Example: "2021-10-03T07:03:36Z"

childobject

Child object data that is queried from database

citizenIdstring

Child ID

Example: "ID2"

firstNamestring

Child first name

Example: "Usha"

lastNamesstring

Child last name

Example: "Bajaj"

birthdatestring (date)

Child data of birth

Example: "2021-10-03T07:03:36Z"

addressstring

Child's address

Example: "Longroad 123, Welltown, Ethiopia"

nationalitystring

Child is a citizen of this country. ISO 3166-1 encoding list

Example: "ET"

birthCertificateFieldFileType (any of)

url*string

originalName*string

type*string

genderenum

MaleFemale

caretakerobject

Caretaker's information

citizenIdstring

Caretaker's ID

Example: "ID1"

firstNamestring

Caretaker's first name

Example: "Sowmya"

lastNamesstring

Caretaker's last name

Example: "Bajaj"

birthdatestring (date)

Caretaker's birth date

Example: "2021-10-03T07:03:36Z"

phonestring

Caretaker's phone number

Example: "+3725278511"

emailstring

Caretaker's email

Example: "test@test.et"

pictureFieldFileType (any of)

url*string

originalName*string

type*string

citizenIdDocFieldFileType (any of)

url*string

originalName*string

type*string

paymentIdstring

createdAt*string (date-time)

modifiedAt*string (date-time)

uuid*string (uuid)

Response

Body

receive*array of object

content*object

idstring

Registration ID

Example: "MCTS31"

startstring (date)

Record registration date

Example: "2021-10-03T07:03:36Z"

expirystring (date)

Record expiry date

Example: "2021-10-03T07:03:36Z"

childobject

Child object data that is queried from database

citizenIdstring

Child ID

Example: "ID2"

firstNamestring

Child first name

Example: "Usha"

lastNamesstring

Child last name

Example: "Bajaj"

birthdatestring (date)

Child data of birth

Example: "2021-10-03T07:03:36Z"

addressstring

Child's address

Example: "Longroad 123, Welltown, Ethiopia"

nationalitystring

Child is a citizen of this country. ISO 3166-1 encoding list

Example: "ET"

birthCertificateFieldFileType (any of)

url*string

originalName*string

type*string

genderenum

MaleFemale

caretakerobject

Caretaker's information

citizenIdstring

Caretaker's ID

Example: "ID1"

firstNamestring

Caretaker's first name

Example: "Sowmya"

lastNamesstring

Caretaker's last name

Example: "Bajaj"

birthdatestring (date)

Caretaker's birth date

Example: "2021-10-03T07:03:36Z"

phonestring

Caretaker's phone number

Example: "+3725278511"

emailstring

Caretaker's email

Example: "test@test.et"

pictureFieldFileType (any of)

url*string

originalName*string

type*string

citizenIdDocFieldFileType (any of)

url*string

originalName*string

type*string

paymentIdstring

createdAt*string (date-time)

modifiedAt*string (date-time)

uuid*string (uuid)

Request

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-05T12:27:58.125Z",
          "modifiedAt": "2024-11-05T12:27:58.125Z",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "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": "+3725278511",
          "email": "test@test.et",
          "picture": {
            "url": "text",
            "originalName": "text",
            "type": "text"
          },
          "citizenIdDoc": {
            "url": "text",
            "originalName": "text",
            "type": "text"
          }
        },
        "paymentId": "text"
      },
      "createdAt": "2024-11-05T12:27:58.125Z",
      "modifiedAt": "2024-11-05T12:27:58.125Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

read

Searches and returns one record.

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

Authorization

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

query*object

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Body

contentExample (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

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

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

schemadatabasesSchema (object)

Example of databases API request response body

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

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

Circular reference to databasesSchema (object) ↩

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

genericServicesarray 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

groupIdinteger

ID of databases group

Example: 10

orderinteger

Order number of databases group

Example: 76

dataIndexIncrementinteger

Data index increment of databases group

Example: 3

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

genericServicesarray 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 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

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

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

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

Circular reference to array of databaseInfo (object) ↩

groupIdinteger

ID of databases group

Example: 10

orderinteger

Order number of databases group

Example: 76

dataIndexIncrementinteger

Data index increment of databases group

Example: 3

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

genericServicesarray 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

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

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

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

delete

Delete record.

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

Authorization

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

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Request

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

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

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Body

any of

string

Request

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

Response

text

list

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

GET/data/{registryName}/{versionNumber}

Authorization

Path parameters

registryName*string

versionNumber*string

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-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Body

count*integer

Number of results

Example: 1

nextstring (uri)

URI to next results page

Example: 1

previousstring (uri)

results*array of Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

Response

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

list

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

GET/data/{registryName}/{versionNumber}

Authorization

Path parameters

registryName*string

versionNumber*string

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-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Body

count*integer

Number of results

Example: 1

nextstring (uri)

URI to next results page

Example: 1

previousstring (uri)

results*array of Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

Response

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

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

query*object

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Body

contentExample (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

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

read

Searches and returns one record.

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

Authorization

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

query*object

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Body

contentExample (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

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

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

GET/data/mypersonalDataUsage

Query parameters

userId*string

User's personal unique identifier

Example: "EE378129277266"

databaseId*string

Database acronym

Example: "MCTS"

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Response

Success Response

Body

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

ReferenceIdstring

Registration ID

Example: "MCTS31"

Request

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

Response

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

update

Updates one existing record in the registry database.

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

Authorization

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

queryobject

Search object that needs to be updated

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

write*object

Update found object with the following data

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Request

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

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

queryobject

Find objects that needs to be updated

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

write*object

Data that needs to be added to the found objects

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Request

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();

exists

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

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

Authorization

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

query*object

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Body

answer*object

status*boolean

Example object found in database

Example: true

messagestring

More information about the object

Example: "Object found from database"

Request

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

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

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

Path parameters

registryName*string

versionNumber*string

Header parameters

Information-Mediator-Client*string

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

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

write*object

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

content*Example (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Response

Body

contentExample (object)

idstring

Citizen's identifier

Example: "EE378627348834"

firstNamestring

Citizen's first name

Example: "John Helmut"

lastNamestring

Citizen's last name

Example: "Smith Carry"

birthCertificateIdstring

Birth certificate ID in CR

Example: "RR-1234567889"

Request

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

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

POST/data/mcts/createEntries

Header parameters

Information-Mediator-Client*string

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: "eGovStack/GOV/90000009/digitalregistries"

Body

write*array of object

content*object

idstring

Registration ID

Example: "MCTS31"

startstring (date)

Record registration date

Example: "2021-10-03T07:03:36Z"

expirystring (date)

Record expiry date

Example: "2021-10-03T07:03:36Z"

childobject

Child object data that is queried from database

citizenIdstring

Child ID

Example: "ID2"

firstNamestring

Child first name

Example: "Usha"

lastNamesstring

Child last name

Example: "Bajaj"

birthdatestring (date)

Child data of birth

Example: "2021-10-03T07:03:36Z"

addressstring

Child's address

Example: "Longroad 123, Welltown, Ethiopia"

nationalitystring

Child is a citizen of this country. ISO 3166-1 encoding list

Example: "ET"

birthCertificateFieldFileType (any of)

url*string

originalName*string

type*string

genderenum

MaleFemale

caretakerobject

Caretaker's information

citizenIdstring

Caretaker's ID

Example: "ID1"

firstNamestring

Caretaker's first name

Example: "Sowmya"

lastNamesstring

Caretaker's last name

Example: "Bajaj"

birthdatestring (date)

Caretaker's birth date

Example: "2021-10-03T07:03:36Z"

phonestring

Caretaker's phone number

Example: "+3725278511"

emailstring

Caretaker's email

Example: "test@test.et"

pictureFieldFileType (any of)

url*string

originalName*string

type*string

citizenIdDocFieldFileType (any of)

url*string

originalName*string

type*string

paymentIdstring

createdAt*string (date-time)

modifiedAt*string (date-time)

uuid*string (uuid)

Response

Body

receive*array of object

content*object

idstring

Registration ID

Example: "MCTS31"

startstring (date)

Record registration date

Example: "2021-10-03T07:03:36Z"

expirystring (date)

Record expiry date

Example: "2021-10-03T07:03:36Z"

childobject

Child object data that is queried from database

citizenIdstring

Child ID

Example: "ID2"

firstNamestring

Child first name

Example: "Usha"

lastNamesstring

Child last name

Example: "Bajaj"

birthdatestring (date)

Child data of birth

Example: "2021-10-03T07:03:36Z"

addressstring

Child's address

Example: "Longroad 123, Welltown, Ethiopia"

nationalitystring

Child is a citizen of this country. ISO 3166-1 encoding list

Example: "ET"

birthCertificateFieldFileType (any of)

url*string

originalName*string

type*string

genderenum

MaleFemale

caretakerobject

Caretaker's information

citizenIdstring

Caretaker's ID

Example: "ID1"

firstNamestring

Caretaker's first name

Example: "Sowmya"

lastNamesstring

Caretaker's last name

Example: "Bajaj"

birthdatestring (date)

Caretaker's birth date

Example: "2021-10-03T07:03:36Z"

phonestring

Caretaker's phone number

Example: "+3725278511"

emailstring

Caretaker's email

Example: "test@test.et"

pictureFieldFileType (any of)

url*string

originalName*string

type*string

citizenIdDocFieldFileType (any of)

url*string

originalName*string

type*string

paymentIdstring

createdAt*string (date-time)

modifiedAt*string (date-time)

uuid*string (uuid)

Request

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-05T12:27:58.125Z",
          "modifiedAt": "2024-11-05T12:27:58.125Z",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "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": "+3725278511",
          "email": "test@test.et",
          "picture": {
            "url": "text",
            "originalName": "text",
            "type": "text"
          },
          "citizenIdDoc": {
            "url": "text",
            "originalName": "text",
            "type": "text"
          }
        },
        "paymentId": "text"
      },
      "createdAt": "2024-11-05T12:27:58.125Z",
      "modifiedAt": "2024-11-05T12:27:58.125Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}