8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Was this helpful?
23Q4
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Was this helpful?
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 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 .
The available services (i.e. registration processes) and form definitions within such a service can be accessed:
Going through the registration process as an applicant requires multiple steps available via API endpoints:
Operators can access and process existing application files:
Currently there are no specifications for API endpoints to manage and design services and workflows.
The statistics API gives Building Block operational statistics, that reference the number of processed applications (per operator, registration, service, date):
API endpoint that allows anyone to see service statistics
Start date of statistics
2021-01-30End date of statistics
2021-01-30Name of registration
MCTSName of operator
Ingmar ValiRole of the operator
HandlerTimerame:
day - timeframe value = dayweek - timeframe value = weekmonth - timeframe value = monthyear - timeframe value = yearFormat is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/eregistrations-devListing of all services with basic information
Register Mother and ChildPass in the ID of the service and it will return all information about that service
The id for a defined service in the registration BB workflow engine.
f7d33db0-2809-484e-a780-76b7ccd4ecbfGet the list of all e-service forms with schema related to the given service
The id for a defined service in the registration BB workflow engine.
f7d33db0-2809-484e-a780-76b7ccd4ecbflist of eForms or an empty array if none are available
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)
id of a service to filter for applications of only this service
Applicant user ID
42962de0-bdb2-11ed-9397-0242ac120004Pagination of results. Specifies the index of the first result to return.
1Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
10Sort 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.
createdSort 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.
ascFormat is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistrieslist of applications or an empty array if none are available
Returns application file
8a70cd6d-bdb2-11ed-9397-0242ac120004Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesReturns task list
Pagination of results. Specifies the index of the first result to return.
Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
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.
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.
list of tasks or an empty array if none are available
Send an application file including all documents and form data to submit a registration request to be processed by operators.
The id for a defined service in the registration BB workflow engine.
f7d33db0-2809-484e-a780-76b7ccd4ecbfFormat is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesFree text application name
Amya YukoApplicant 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.
42962de0-bdb2-11ed-9397-0242ac120004Time when the application file was created by the user- Draft
2000-10-23T00:00:00.000ZUpload a document/attachment to receive a documentId that can be linked to applications when submitting a new registration
Additional Metadata
V2UgbG92ZSBqc29uIQ==Returns updated service application file ID
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesFree text application name
Amya YukoApplicant 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.
42962de0-bdb2-11ed-9397-0242ac120004Time when the application file was created by the user- Draft
2000-10-23T00:00:00.000Z