# 8 Service APIs 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](https://govstack.gitbook.io/specification/v/1.0/architecture-and-nonfunctional-requirements/6-onboarding) 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](https://github.com/GovStackWorkingGroup/bb-scheduler/tree/main/test). ### 8.1 Event Management {% openapi src="" path="/event/new" method="post" %} {% endopenapi %} {% openapi src="" path="/event/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/event" method="delete" %} {% endopenapi %} {% openapi src="" path="/event/list\_details" method="get" %} {% endopenapi %} ### 8.2 Entity Management {% openapi src="" path="/entity/new" method="post" %} {% endopenapi %} {% openapi src="" path="/entity/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/entity" method="delete" %} {% endopenapi %} {% openapi src="" path="/entity/list\_details" method="get" %} {% endopenapi %} ### 8.3 Alert Schedule Management {% openapi src="" path="/alert\_schedule/new" method="post" %} {% endopenapi %} {% openapi src="" path="/alert\_schedule/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/alert\_schedule" method="delete" %} {% endopenapi %} {% openapi src="" path="/alert\_schedule/list\_details" method="get" %} {% endopenapi %} ### 8.4 Alert Message Management {% openapi src="" path="/message/new" method="post" %} {% endopenapi %} {% openapi src="" path="/message/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/message" method="delete" %} {% endopenapi %} {% openapi src="" path="/message/list\_details" method="get" %} {% endopenapi %} ### 8.5 Resource management {% openapi src="" path="/resource/new" method="post" %} {% endopenapi %} {% openapi src="" path="/resource/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/resource" method="delete" %} {% endopenapi %} {% openapi src="" path="/resource/list\_details" method="get" %} {% endopenapi %} {% openapi src="" path="/resource/availability" method="get" %} {% endopenapi %} ### 8.6 Subscriber management {% openapi src="" path="/subscriber/new" method="post" %} {% endopenapi %} {% openapi src="" path="/subscriber/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/subscriber" method="delete" %} {% endopenapi %} {% openapi src="" path="/subscriber/list\_details" method="get" %} {% endopenapi %} ### 8.7 Affiliation management {% openapi src="" path="/affiliation/new" method="post" %} {% endopenapi %} {% openapi src="" path="/affiliation/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/affiliation" method="delete" %} {% endopenapi %} {% openapi src="" path="/affiliation/list\_details" method="get" %} {% endopenapi %} ### 8.8 Appointment management {% openapi src="" path="/appointment/new" method="post" %} {% endopenapi %} {% openapi src="" path="/appointment/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/appointment" method="delete" %} {% endopenapi %} {% openapi src="" path="/appointment/list\_details" method="get" %} {% endopenapi %} ### 8.9 Status Logging and Reporting {% openapi src="" path="/log/new" method="post" %} {% endopenapi %} {% openapi src="" path="/log/modifications" method="put" %} {% endopenapi %} {% openapi src="" path="/log" method="delete" %} {% endopenapi %} {% openapi src="" path="/log/list\_details" method="get" %} {% endopenapi %} ## **4.10 Information Mediator Interface** This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification. ## **4.11 PubSub Interface** This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification. ## **4.12 Messaging interface** This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification. ## **4.13 Scheduler Administration** This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification. ## API standards * The microservice interfaces are defined as per [OPENAPI Ver3.0 standards](https://swagger.io/specification/). * For implementation purposes, it is suggested to refer [TMF630\_REST\_API\_Design\_Guidelines](https://www.tmforum.org/resources/standard/tmf630-rest-api-design-guidelines-4-2-0/). --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://scheduler.govstack.global/development-7/8-service-apis.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.