This section provides a reference for APIs that should be implemented by this Building Block.
A Set of microservices are defined to receive requests from other GovStack-compatible Building Blocks and applications with relevant inputs and return processed results from key digital functionalities of this Building Block. 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.
Scheduler must expose its microservices through RESTful API interfaces as defined by OpenAPI v3+ standards. The Scheduler must have any response data payload it returns through its API only in the form of JSON formatted datasets. A summary of the APIS exposed by this Building Block is summarized in the table below. The Scheduler Building Block can be used also as an internal sub-block of another Building Block. In such a case the same services APIs will be used to embed the Scheduler Building Block (without having to pass through the Information Mediator).
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 Scheduler Building Block can be found in this GitHub repository.
This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.
This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.
This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.
This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.
The microservice interfaces are defined as per OPENAPI Ver3.0 standards.
For implementation purposes, it is suggested to refer TMF630_REST_API_Design_Guidelines.
success, entity cancelled
success, alert_schedule cancelled
success, message cancelled
success, resource cancelled
success, subscriber cancelled
success, affiliation cancelled
success, appointment cancelled
success, log cancelled
success, event cancelled
success, message updated
success, affiliation updated
success, alert_schedule updated
success, entity updated
success
ID of created message
success, appointment updated
success, log updated
success
ID of created alert_schedule
success, resource updated
success, subscriber updated
success
ID of created entity
success
ID of created appointment
success
ID of created log
success
ID of created resource
success
ID of created subscriber
success
ID of created affiliation
success,resource list
success,message list
success, event updated
success,alert_schedule list
success,affiliation list
success,entity list
success,log list
success
ID of created event
success,appointment_list
success,resource list
success,message list
success,event_list