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.
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:
Existing applications can be accessed after submission:
Operators can access and process existing application files
The statistics API gives Building Block operational statistics, that reference the number of processed applications (per operator, registration, service, date):
Returns task by id
Returns task by id
Returns 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
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
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.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
list of applications or an empty array if none are available
Application file identifier 81c4445c-bff6-11ed-afa1-0242ac120002
operator ID who is processing the applicant file
operator ID who has the task of processing the application file
Time when the application file was created by the user- Draft
Time when the application file was registered in the Registration BB system
Get 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.
list of eForms or an empty array if none are available
The unique identifier of the e-form
The name of the e-form
A description of the e-form
Version of the e-form
True if the last version
Returns application file
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
Returns application file by id
Application file identifier 81c4445c-bff6-11ed-afa1-0242ac120002
Time when the application file was registered in the Registration BB system
id of the service this application relates to
True, if application file processing has ended
Free text application name
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.
Time when the application file was created by the user- Draft
Form ID used in the data capturing
Get 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.
list of eForms or an empty array if none are available
The unique identifier of the e-form
The name of the e-form
A description of the e-form
Version of the e-form
True if the last version
Upload a document/attachment to receive a documentId that can be linked to applications when submitting a new registration
Additional Metadata
File successfully uploaded
Pass 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.
Service found and representation returned
unique identifier (serviceId)
name of a service
service version number
Specifies whether the service is executable
whether Messages and Events, not modeled in Service, can occur when the service is executed or performed
Upload a document/attachment to receive a documentId that can be linked to applications when submitting a new registration
Additional Metadata
File successfully uploaded
The ID of the e-form to retrieve
OK
The unique identifier of the e-form
The name of the e-form
A description of the e-form
Version of the e-form
True if the last version
The JSON schema of the e-form
Returns 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
Listing of all services with basic information
list of services or an empty array if none are available
unique identifier (serviceId)
name of a service
service version number
Specifies whether the service is executable
whether Messages and Events, not modeled in Service, can occur when the service is executed or performed
Returns task by id
Returns task by id
Returns application file
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
Returns application file by id
Application file identifier 81c4445c-bff6-11ed-afa1-0242ac120002
Time when the application file was registered in the Registration BB system
id of the service this application relates to
True, if application file processing has ended
Free text application name
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.
Time when the application file was created by the user- Draft
Form ID used in the data capturing
Pass 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.
Service found and representation returned
unique identifier (serviceId)
name of a service
service version number
Specifies whether the service is executable
whether Messages and Events, not modeled in Service, can occur when the service is executed or performed
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.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
Create a new application file in the system
Free text application name
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.
Time when the application file was created by the user- Draft
Form ID used in the data capturing
Returns started application file ID
Application file identifier 81c4445c-bff6-11ed-afa1-0242ac120002
Time when the application file was registered in the Registration BB system
id of the service this application relates to
True, if application file processing has ended
Free text application name
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.
Time when the application file was created by the user- Draft
Form ID used in the data capturing
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.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
Create a new application file in the system
Free text application name
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.
Time when the application file was created by the user- Draft
Form ID used in the data capturing
Returns started application file ID
Application file identifier 81c4445c-bff6-11ed-afa1-0242ac120002
Time when the application file was registered in the Registration BB system
id of the service this application relates to
True, if application file processing has ended
Free text application name
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.
Time when the application file was created by the user- Draft
Form ID used in the data capturing
Task successfully completed
Returns updated service application file ID
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
Update application file data with operators input
Free text application name
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.
Time when the application file was created by the user- Draft
Form ID used in the data capturing
Returns updated application file
Application file identifier 81c4445c-bff6-11ed-afa1-0242ac120002
Time when the application file was registered in the Registration BB system
id of the service this application relates to
True, if application file processing has ended
Free text application name
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.
Time when the application file was created by the user- Draft
Form ID used in the data capturing
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
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.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
list of applications or an empty array if none are available
Application file identifier 81c4445c-bff6-11ed-afa1-0242ac120002
operator ID who is processing the applicant file
operator ID who has the task of processing the application file
Time when the application file was created by the user- Draft
Time when the application file was registered in the Registration BB system
API endpoint that allows anyone to see service statistics
Start date of statistics
End date of statistics
Name of registration
Name of operator
Role of the operator
Timerame:
day
- timeframe value = dayweek
- timeframe value = weekmonth
- timeframe value = monthyear
- timeframe value = yearFormat is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
Success Response
How many applications was processed
How many applications was approved
How many applications was sent back
How many applications was rejected
Data that was requested