Give FeedbackGovStack Home

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 Registration Building Block can be found in this GitHub repository.

8.1 Online Registration e-services

The available services (i.e. registration processes) and form definitions within such a service can be accessed:

returns a list of services (Services available to use)

get

Listing of all services with basic information

Query parameters
namestringOptionalExample: Register Mother and Child
Responses
200
list of services or an empty array if none are available
application/json
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//services HTTP/1.1
Host: ss2.egovstack.net
Accept: */*

[
  {
    "id": "f7d33db0-2809-484e-a780-76b7ccd4ecbf",
    "name": "Mother and Child Registration",
    "version": "123",
    "type": "None",
    "isExecutable": true,
    "isClosed": true,
    "description": "text",
    "serviceBody": [
      {
        "code": "text",
        "value": "text"
      }
    ]
  }
]

returns detailed information about a service

get

Pass in the ID of the service and it will return all information about that service

Path parameters
serviceIdstring · uuidRequired

The id for a defined service in the registration BB workflow engine.

Example: f7d33db0-2809-484e-a780-76b7ccd4ecbf
Responses
200
Service found and representation returned
application/json
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//services/{serviceId} HTTP/1.1
Host: ss2.egovstack.net
Accept: */*

{
  "id": "f7d33db0-2809-484e-a780-76b7ccd4ecbf",
  "name": "Mother and Child Registration",
  "version": "123",
  "type": "None",
  "isExecutable": true,
  "isClosed": true,
  "description": "text",
  "serviceBody": [
    {
      "code": "text",
      "value": "text"
    }
  ]
}

Retrieve all available e-forms

get

Get the list of all e-service forms with schema related to the given service

Path parameters
serviceIdstring · uuidRequired

The id for a defined service in the registration BB workflow engine.

Example: f7d33db0-2809-484e-a780-76b7ccd4ecbf
Responses
200
list of eForms or an empty array if none are available
application/json
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//services/{serviceId}/eForms HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
200

list of eForms or an empty array if none are available

[
  {
    "eFormId": "d98a205a-679b-485b-823d-7a32a391e744",
    "name": "FORM",
    "description": "text",
    "version": "1",
    "latest": true
  }
]

returns detailed information about a service

get

Pass in the ID of the service and it will return all information about that service

Path parameters
serviceIdstring · uuidRequired

The id for a defined service in the registration BB workflow engine.

Example: f7d33db0-2809-484e-a780-76b7ccd4ecbf
Responses
200
Service found and representation returned
application/json
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//services/{serviceId} HTTP/1.1
Host: ss2.egovstack.net
Accept: */*

{
  "id": "f7d33db0-2809-484e-a780-76b7ccd4ecbf",
  "name": "Mother and Child Registration",
  "version": "123",
  "type": "None",
  "isExecutable": true,
  "isClosed": true,
  "description": "text",
  "serviceBody": [
    {
      "code": "text",
      "value": "text"
    }
  ]
}

Retrieve all available e-forms

get

Get the list of all e-service forms with schema related to the given service

Path parameters
serviceIdstring · uuidRequired

The id for a defined service in the registration BB workflow engine.

Example: f7d33db0-2809-484e-a780-76b7ccd4ecbf
Responses
200
list of eForms or an empty array if none are available
application/json
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//services/{serviceId}/eForms HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
200

list of eForms or an empty array if none are available

[
  {
    "eFormId": "d98a205a-679b-485b-823d-7a32a391e744",
    "name": "FORM",
    "description": "text",
    "version": "1",
    "latest": true
  }
]

Retrieve a specific e-form by ID

get
Path parameters
eFormIdstringRequired

The ID of the e-form to retrieve

Responses
200
OK
application/json
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//eForms/{eFormId} HTTP/1.1
Host: ss2.egovstack.net
Accept: */*

{
  "eFormId": "d98a205a-679b-485b-823d-7a32a391e744",
  "name": "A1",
  "description": "text",
  "version": "1",
  "latest": true,
  "schema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

8.2 Generic Registration Steps

Going through the registration process as an applicant requires multiple steps available via API endpoints:

Submit an application file as an applicant

post

Send an application file including all documents and form data to submit a registration request to be processed by operators.

Path parameters
serviceIdstring · uuidRequired

The id for a defined service in the registration BB workflow engine.

Example: f7d33db0-2809-484e-a780-76b7ccd4ecbf
Header parameters
Information-Mediator-ClientstringRequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries
Body
applicationNamestringOptional

Free text application name

Example: Amya Yuko
applicantIdstringRequired

Applicant is a user who submitted application, this id references the user account logged in on the system and submitting this request. The applicantId could also come from OAuth2 and OpenID Connect authentication. New applicant records are created by the system internally if necessary.

Example: 42962de0-bdb2-11ed-9397-0242ac120004
createdstring · date-timeOptional

Time when the application file was created by the user- Draft

Example: 2000-10-23T00:00:00.000Z
documentUrlsstring[]Optional
Responses
200
Returns started application file ID
*/*
post
POST /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//services/{serviceId}/applications HTTP/1.1
Host: ss2.egovstack.net
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "applicationName": "Amya Yuko",
  "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
  "created": "2000-10-23T00:00:00.000Z",
  "formData": {
    "data": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "eFormId": "42962de0-bdb2-11ed-9397-0242ac120004"
  },
  "documentUrls": [
    "text"
  ]
}
{
  "fileId": "81c4445c-bff6-11ed-afa1-0242ac120002",
  "registered": "2000-10-23T00:00:00.000Z",
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "serviceName": "Post partum registration service",
  "status": {
    "code": "PENDING",
    "title": "Pending"
  },
  "ended": "false",
  "applicationData": {
    "applicationName": "Amya Yuko",
    "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "created": "2000-10-23T00:00:00.000Z",
    "formData": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "eFormId": "42962de0-bdb2-11ed-9397-0242ac120004"
    },
    "documentUrls": [
      "text"
    ]
  }
}

Submit an application file as an applicant

post

Send an application file including all documents and form data to submit a registration request to be processed by operators.

Path parameters
serviceIdstring · uuidRequired

The id for a defined service in the registration BB workflow engine.

Example: f7d33db0-2809-484e-a780-76b7ccd4ecbf
Header parameters
Information-Mediator-ClientstringRequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries
Body
applicationNamestringOptional

Free text application name

Example: Amya Yuko
applicantIdstringRequired

Applicant is a user who submitted application, this id references the user account logged in on the system and submitting this request. The applicantId could also come from OAuth2 and OpenID Connect authentication. New applicant records are created by the system internally if necessary.

Example: 42962de0-bdb2-11ed-9397-0242ac120004
createdstring · date-timeOptional

Time when the application file was created by the user- Draft

Example: 2000-10-23T00:00:00.000Z
documentUrlsstring[]Optional
Responses
200
Returns started application file ID
*/*
post
POST /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//services/{serviceId}/applications HTTP/1.1
Host: ss2.egovstack.net
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "applicationName": "Amya Yuko",
  "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
  "created": "2000-10-23T00:00:00.000Z",
  "formData": {
    "data": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "eFormId": "42962de0-bdb2-11ed-9397-0242ac120004"
  },
  "documentUrls": [
    "text"
  ]
}
{
  "fileId": "81c4445c-bff6-11ed-afa1-0242ac120002",
  "registered": "2000-10-23T00:00:00.000Z",
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "serviceName": "Post partum registration service",
  "status": {
    "code": "PENDING",
    "title": "Pending"
  },
  "ended": "false",
  "applicationData": {
    "applicationName": "Amya Yuko",
    "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "created": "2000-10-23T00:00:00.000Z",
    "formData": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "eFormId": "42962de0-bdb2-11ed-9397-0242ac120004"
    },
    "documentUrls": [
      "text"
    ]
  }
}

Upload a required document

post

Upload a document/attachment to receive a documentId that can be linked to applications when submitting a new registration

Query parameters
additionalMetadatastringOptional

Additional Metadata

Body
filestring · base64[]OptionalExample: V2UgbG92ZSBqc29uIQ==
Responses
200
File successfully uploaded
*/*
post
POST /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//documents HTTP/1.1
Host: ss2.egovstack.net
Content-Type: multipart/form-data
Accept: */*
Content-Length: 33

{
  "file": [
    "V2UgbG92ZSBqc29uIQ=="
  ]
}
{
  "code": 1,
  "type": "text",
  "message": "text",
  "url": "text"
}

Existing applications can be accessed after submission:

Retrieve all application files

get

Returns a list of application files the user has permission to access (i.e. either only the applicant's own applications or all applications for an operator to process)

Query parameters
serviceIdstring · uuidOptional

id of a service to filter for applications of only this service

applicantIdstringOptional

Applicant user ID

Example: 42962de0-bdb2-11ed-9397-0242ac120004
firstResultintegerOptional

Pagination of results. Specifies the index of the first result to return.

Example: 1
maxResultintegerOptional

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Example: 10
sortBystringOptional

Sort the results lexicographically by a given criterion. Valid values are instanceId, caseInstanceId, dueDate, executionId, caseExecutionId,assignee, created, description, id, name, nameCaseInsensitive and priority. Must be used in conjunction with the sortOrder parameter.

Example: created
sortOrderstringOptional

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Example: asc
Header parameters
Information-Mediator-ClientstringRequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries
Responses
200
list of applications or an empty array if none are available
*/*
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//applications HTTP/1.1
Host: ss2.egovstack.net
Information-Mediator-Client: text
Accept: */*
200

list of applications or an empty array if none are available

[
  {
    "fileId": "81c4445c-bff6-11ed-afa1-0242ac120002",
    "mainTaskId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "taskTitle": "Application xyz",
    "roleId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "roleName": "Registrar",
    "assigneeId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "operatorName": "John Smith",
    "status": {
      "code": "PENDING",
      "title": "Pending"
    },
    "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "created": "2000-10-23T00:00:00.000Z",
    "registered": "2000-10-23T00:00:00.000Z",
    "description": "Any text.",
    "serviceName": "Post partum registration service",
    "serviceId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "eformId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "documentUrls": [
      "text"
    ],
    "additionalMeta": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  }
]

Get application file by ID

get

Returns application file

Path parameters
fileIdstringRequiredExample: 8a70cd6d-bdb2-11ed-9397-0242ac120004
Header parameters
Information-Mediator-ClientstringRequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries
Responses
200
Returns application file by id
*/*
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//applications/{fileId} HTTP/1.1
Host: ss2.egovstack.net
Information-Mediator-Client: text
Accept: */*

{
  "fileId": "81c4445c-bff6-11ed-afa1-0242ac120002",
  "registered": "2000-10-23T00:00:00.000Z",
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "serviceName": "Post partum registration service",
  "status": {
    "code": "PENDING",
    "title": "Pending"
  },
  "ended": "false",
  "applicationData": {
    "applicationName": "Amya Yuko",
    "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "created": "2000-10-23T00:00:00.000Z",
    "formData": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "eFormId": "42962de0-bdb2-11ed-9397-0242ac120004"
    },
    "documentUrls": [
      "text"
    ]
  }
}

Retrieve all tasks

get

Returns task list

Query parameters
mainTaskIdstringOptional
fileIdstringOptional
assigneeIdstringOptional
firstResultintegerOptional

Pagination of results. Specifies the index of the first result to return.

maxResultintegerOptional

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

sortBystringOptional

Sort the results lexicographically by a given criterion. Valid values are instanceId, caseInstanceId, dueDate, executionId, caseExecutionId,assignee, created, description, id, name, nameCaseInsensitive and priority. Must be used in conjunction with the sortOrder parameter.

sortOrderstringOptional

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Responses
200
list of tasks or an empty array if none are available
*/*
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//tasks HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
200

list of tasks or an empty array if none are available

[
  {
    "taskId": "text",
    "mainTaskId": "text",
    "name": "text",
    "assigneeId": "text",
    "roleId": "text",
    "created": "2025-06-24T22:35:08.700Z",
    "description": "text",
    "serviceId": "123e4567-e89b-12d3-a456-426614174000",
    "serviceName": "text",
    "fileId": "text",
    "eFormId": "text",
    "status": {
      "code": "PENDING",
      "title": "Pending"
    }
  }
]

Get task by id

get

Returns task by id

Path parameters
taskIdstringRequired
Responses
200
Returns task by id
*/*
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//tasks/{taskId} HTTP/1.1
Host: ss2.egovstack.net
Accept: */*

{
  "taskId": "text",
  "taskName": "text",
  "assigneeId": "text",
  "roleId": "42962de0-bdb2-11ed-9397-0242ac120004",
  "created": "2025-06-24T22:35:08.700Z",
  "description": "text",
  "fileId": "text",
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "serviceName": "text",
  "eFormId": "text",
  "formVariables": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "status": {
    "code": "PENDING",
    "title": "Pending"
  },
  "data": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

8.3 Development Platform

Operators can access and process existing application files

Retrieve all application files

get

Returns a list of application files the user has permission to access (i.e. either only the applicant's own applications or all applications for an operator to process)

Query parameters
serviceIdstring · uuidOptional

id of a service to filter for applications of only this service

applicantIdstringOptional

Applicant user ID

Example: 42962de0-bdb2-11ed-9397-0242ac120004
firstResultintegerOptional

Pagination of results. Specifies the index of the first result to return.

Example: 1
maxResultintegerOptional

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Example: 10
sortBystringOptional

Sort the results lexicographically by a given criterion. Valid values are instanceId, caseInstanceId, dueDate, executionId, caseExecutionId,assignee, created, description, id, name, nameCaseInsensitive and priority. Must be used in conjunction with the sortOrder parameter.

Example: created
sortOrderstringOptional

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Example: asc
Header parameters
Information-Mediator-ClientstringRequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries
Responses
200
list of applications or an empty array if none are available
*/*
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//applications HTTP/1.1
Host: ss2.egovstack.net
Information-Mediator-Client: text
Accept: */*
200

list of applications or an empty array if none are available

[
  {
    "fileId": "81c4445c-bff6-11ed-afa1-0242ac120002",
    "mainTaskId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "taskTitle": "Application xyz",
    "roleId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "roleName": "Registrar",
    "assigneeId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "operatorName": "John Smith",
    "status": {
      "code": "PENDING",
      "title": "Pending"
    },
    "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "created": "2000-10-23T00:00:00.000Z",
    "registered": "2000-10-23T00:00:00.000Z",
    "description": "Any text.",
    "serviceName": "Post partum registration service",
    "serviceId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "eformId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "documentUrls": [
      "text"
    ],
    "additionalMeta": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  }
]

Get application file by ID

get

Returns application file

Path parameters
fileIdstringRequiredExample: 8a70cd6d-bdb2-11ed-9397-0242ac120004
Header parameters
Information-Mediator-ClientstringRequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries
Responses
200
Returns application file by id
*/*
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//applications/{fileId} HTTP/1.1
Host: ss2.egovstack.net
Information-Mediator-Client: text
Accept: */*

{
  "fileId": "81c4445c-bff6-11ed-afa1-0242ac120002",
  "registered": "2000-10-23T00:00:00.000Z",
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "serviceName": "Post partum registration service",
  "status": {
    "code": "PENDING",
    "title": "Pending"
  },
  "ended": "false",
  "applicationData": {
    "applicationName": "Amya Yuko",
    "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "created": "2000-10-23T00:00:00.000Z",
    "formData": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "eFormId": "42962de0-bdb2-11ed-9397-0242ac120004"
    },
    "documentUrls": [
      "text"
    ]
  }
}

Update service application file with operator's form data

put

Returns updated service application file ID

Path parameters
fileIdstringRequired
Header parameters
Information-Mediator-ClientstringRequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/digitalregistries
Body
applicationNamestringOptional

Free text application name

Example: Amya Yuko
applicantIdstringRequired

Applicant is a user who submitted application, this id references the user account logged in on the system and submitting this request. The applicantId could also come from OAuth2 and OpenID Connect authentication. New applicant records are created by the system internally if necessary.

Example: 42962de0-bdb2-11ed-9397-0242ac120004
createdstring · date-timeOptional

Time when the application file was created by the user- Draft

Example: 2000-10-23T00:00:00.000Z
documentUrlsstring[]Optional
Responses
200
Returns updated application file
*/*
put
PUT /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//applications/{fileId} HTTP/1.1
Host: ss2.egovstack.net
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "applicationName": "Amya Yuko",
  "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
  "created": "2000-10-23T00:00:00.000Z",
  "formData": {
    "data": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "eFormId": "42962de0-bdb2-11ed-9397-0242ac120004"
  },
  "documentUrls": [
    "text"
  ]
}
{
  "fileId": "81c4445c-bff6-11ed-afa1-0242ac120002",
  "registered": "2000-10-23T00:00:00.000Z",
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "serviceName": "Post partum registration service",
  "status": {
    "code": "PENDING",
    "title": "Pending"
  },
  "ended": "false",
  "applicationData": {
    "applicationName": "Amya Yuko",
    "applicantId": "42962de0-bdb2-11ed-9397-0242ac120004",
    "created": "2000-10-23T00:00:00.000Z",
    "formData": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "eFormId": "42962de0-bdb2-11ed-9397-0242ac120004"
    },
    "documentUrls": [
      "text"
    ]
  }
}

Upload a required document

post

Upload a document/attachment to receive a documentId that can be linked to applications when submitting a new registration

Query parameters
additionalMetadatastringOptional

Additional Metadata

Body
filestring · base64[]OptionalExample: V2UgbG92ZSBqc29uIQ==
Responses
200
File successfully uploaded
*/*
post
POST /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//documents HTTP/1.1
Host: ss2.egovstack.net
Content-Type: multipart/form-data
Accept: */*
Content-Length: 33

{
  "file": [
    "V2UgbG92ZSBqc29uIQ=="
  ]
}
{
  "code": 1,
  "type": "text",
  "message": "text",
  "url": "text"
}

Retrieve all tasks

get

Returns task list

Query parameters
mainTaskIdstringOptional
fileIdstringOptional
assigneeIdstringOptional
firstResultintegerOptional

Pagination of results. Specifies the index of the first result to return.

maxResultintegerOptional

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

sortBystringOptional

Sort the results lexicographically by a given criterion. Valid values are instanceId, caseInstanceId, dueDate, executionId, caseExecutionId,assignee, created, description, id, name, nameCaseInsensitive and priority. Must be used in conjunction with the sortOrder parameter.

sortOrderstringOptional

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Responses
200
list of tasks or an empty array if none are available
*/*
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//tasks HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
200

list of tasks or an empty array if none are available

[
  {
    "taskId": "text",
    "mainTaskId": "text",
    "name": "text",
    "assigneeId": "text",
    "roleId": "text",
    "created": "2025-06-24T22:35:08.700Z",
    "description": "text",
    "serviceId": "123e4567-e89b-12d3-a456-426614174000",
    "serviceName": "text",
    "fileId": "text",
    "eFormId": "text",
    "status": {
      "code": "PENDING",
      "title": "Pending"
    }
  }
]

Get task by id

get

Returns task by id

Path parameters
taskIdstringRequired
Responses
200
Returns task by id
*/*
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//tasks/{taskId} HTTP/1.1
Host: ss2.egovstack.net
Accept: */*

{
  "taskId": "text",
  "taskName": "text",
  "assigneeId": "text",
  "roleId": "42962de0-bdb2-11ed-9397-0242ac120004",
  "created": "2025-06-24T22:35:08.700Z",
  "description": "text",
  "fileId": "text",
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "serviceName": "text",
  "eFormId": "text",
  "formVariables": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "status": {
    "code": "PENDING",
    "title": "Pending"
  },
  "data": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Complete task by id

post
Path parameters
taskIdstringRequired
Body
Responses
200
Task successfully completed
*/*
post
POST /r1/eGovStack/COM/11222456/RegistrationBB/creg/api//tasks/{taskId}/complete HTTP/1.1
Host: ss2.egovstack.net
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "taskId": "text",
  "fileId": "text",
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "status": {
    "code": "PENDING",
    "title": "Pending"
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  }
}

Statistics

The statistics API gives Building Block operational statistics, that reference the number of processed applications (per operator, registration, service, date):

get

API endpoint that allows anyone to see service statistics

Query parameters
startDatestring · dateOptional

Start date of statistics

Example: 2021-01-30
endDatestring · dateOptional

End date of statistics

Example: 2021-01-30
registrationNamestringOptional

Name of registration

Example: MCTS
operatorstringOptional

Name of operator

Example: Ingmar Vali
rolestringOptional

Role of the operator

Example: Handler
timeframestring · enumOptional

Timerame:

  • day - timeframe value = day
  • week - timeframe value = week
  • month - timeframe value = month
  • year - timeframe value = year
Possible values:
Header parameters
Information-Mediator-ClientstringRequired

Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM

Example: eGovStack/GOV/90000009/eregistrations-dev
Responses
200
Success Response
application/json
get
GET /r1/eGovStack/COM/11222456/RegistrationBB/creg//data/statistics/1.0 HTTP/1.1
Host: ss2.egovstack.net
Information-Mediator-Client: text
Accept: */*

[]

Last updated

Was this helpful?