8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Was this helpful?
Development
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Was this helpful?
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 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 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 .
For implementation purposes, it is suggested to refer .
healthngoadmin1OrganizerID of created event
event_id:12345healthngoadmin1Organizer12345No content
healthngoadmin1Organizer12345No content
healthngoadmin1Organizerhealthngoadmin1OrganizerID of created entity
entity_name:xyz hospital,entity_id:67890healthngoadmin1Organizer67890No content
healthngoadmin1Organizer67890No content
healthngoadmin1Organizerhealthngoadmin1OrganizerID of created alert_schedule
alert_schedule_name:xyz hospital,alert_schedule_id:1healthngoadmin1Organizer1No content
healthngoadmin1Organizer1No content
healthngoadmin1Organizerhealthngoadmin1OrganizerID of created message
message_name:xyz hospital,message_id:1healthngoadmin1Organizer1No content
healthngoadmin1Organizer1No content
healthngoadmin1Organizerhealthngoadmin1OrganizerID of created resource
resource_name:xyz hospital,resource_id:54321healthngoadmin1Organizer54321No content
healthngoadmin1Organizer54321No content
healthngoadmin1Organizerhealthngoadmin1Organizerhealthngoadmin1OrganizerID of created subscriber
subscriber_name:xyz hospital,subscriber_id:12345healthngoadmin1Organizer12345No content
healthngoadmin1Organizer12345No content
healthngoadmin1Organizerhealthngoadmin1OrganizerID of created affiliation
affiliation_name:xyz hospital,affiliation_id:1healthngoadmin1Organizer1No content
healthngoadmin1Organizer1No content
healthngoadmin1Organizerhealthngoadmin1OrganizerID of created appointment
[Event_id:12345,appointment_id:1]healthngoadmin1Organizer1No content
healthngoadmin1Organizer1No content
healthngoadmin1Organizerhealthngoadmin1OrganizerID of created log
log_name:xyz hospital,log_id:1healthngoadmin1Organizer1No content
healthngoadmin1Organizer1No content
healthngoadmin1Organizer