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.
"healthngoadmin1"
"Organizer"
"67890"
success, entity cancelled
"healthngoadmin1"
"Organizer"
"1"
success, alert_schedule cancelled
"healthngoadmin1"
"Organizer"
"1"
success, message cancelled
"healthngoadmin1"
"Organizer"
"54321"
success, resource cancelled
"healthngoadmin1"
"Organizer"
"12345"
success, subscriber cancelled
"healthngoadmin1"
"Organizer"
"1"
success, affiliation cancelled
"healthngoadmin1"
"Organizer"
"1"
success, appointment cancelled
"healthngoadmin1"
"Organizer"
"1"
success, log cancelled
"healthngoadmin1"
"Organizer"
"12345"
success, event cancelled
"healthngoadmin1"
"Organizer"
"1"
"67890"
"reminder"
"you have doctor consultation today"
success, message updated
"healthngoadmin1"
"Organizer"
"1"
"12345"
"67890"
"physician"
"[monday"
"09:00:00"
"17:00:00"
success, affiliation updated
"healthngoadmin1"
"Organizer"
"1"
"12345"
"subscriber"
"1"
"2018-02-15T09:00:00"
success, alert_schedule updated
"healthngoadmin1"
"Organizer"
"67890"
"hospital"
"abc"
"+911234567890"
"info@xyz.com"
"www.abc.com"
success, entity updated
"healthngoadmin1"
"Organizer"
"67890"
"reminder"
"you have doctor consultation today"
success
ID of created message
"message_name:xyz hospital,message_id:1"
"healthngoadmin1"
"Organizer"
"1"
"true"
"1"
"subscriber"
"12345"
"confirmed"
"67890"
success, appointment updated
"healthngoadmin1"
"Organizer"
"1"
"resource"
"1"
"67890"
"attendance"
"2018-02-15T11:00:00"
"event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"
success, log updated
"healthngoadmin1"
"Organizer"
"12345"
"subscriber"
"1"
"2018-02-15T09:00:00"
success
ID of created alert_schedule
"alert_schedule_name:xyz hospital,alert_schedule_id:1"
"healthngoadmin1"
"Organizer"
"54321"
"psrk"
"doctor"
"+911234567890"
"doctor1@xyz.com"
"psrk@gmail.com"
"phone"
"www.doctor1.com"
success, resource updated
"healthngoadmin1"
"Organizer"
"12345"
"abc"
"patient"
"+911234567890"
"abc@gmail.com"
"www.abc.com"
"phone"
"www.abc.com"
success, subscriber updated
"healthngoadmin1"
"Organizer"
"hospital"
"abc"
"+911234567890"
"info@xyz.com"
"www.abc.com"
success
ID of created entity
"entity_name:xyz hospital,entity_id:67890"
"healthngoadmin1"
"Organizer"
"true"
"[1]"
"subscriber"
"12345"
"67890"
success
ID of created appointment
"[Event_id:12345,appointment_id:1]"
"healthngoadmin1"
"Organizer"
"resource"
"1"
"67890"
"attendance"
"2018-02-15T11:00:00"
"event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"
success
ID of created log
"log_name:xyz hospital,log_id:1"
"healthngoadmin1"
"Organizer"
"psrk"
"doctor"
"+911234567890"
"doctor1@xyz.com"
"psrk@gmail.com"
"phone"
"www.doctor1.com"
success
ID of created resource
"resource_name:xyz hospital,resource_id:54321"
"healthngoadmin1"
"Organizer"
"abc"
"patient"
"+911234567890"
"abc@gmail.com"
"www.abc.com"
"phone"
"www.abc.com"
success
ID of created subscriber
"subscriber_name:xyz hospital,subscriber_id:12345"
"healthngoadmin1"
"Organizer"
"12345"
"67890"
"physician"
"[monday"
"09:00:00"
"17:00:00"
success
ID of created affiliation
"affiliation_name:xyz hospital,affiliation_id:1"
"healthngoadmin1"
"Organizer"
"doctor"
"67890"
"2018-02-14T09:00:00"
"2018-02-18T13:30:00"
"1"
success,resource list
"1"
"abc"
"{[2018-02-15T11:00:00to2018-02-15T11:09:00:00],[2018-02-22T11:00:00to2018-02-22T11:17:00:00]}"
"healthngoadmin1"
"Organizer"
"[1,2]"
"67890"
"reminder"
"you have doctor consultation today"
true
true
true
true
success,message list
"1"
"67890"
"reminder"
"you have doctor consultation today"
"healthngoadmin1"
"Organizer"
"12345"
"abc medical camp"
"medical camp for senior citizens"
"doctor_consultation"
"67890"
"2018-02-15T11:00:00"
"2018-02-15T11:30:00"
"2018-02-15T11:10:00"
"1"
"non refundable"
"open"
"xyz"
"7th main"
"wilson garden"
"bangalore"
"karnataka"
"india"
"0.001"
"0.002"
success, event updated
"healthngoadmin1"
"Organizer"
"[1,2]"
"67890"
"subscriber"
"1"
"2018-02-15T09:00:00"
"2018-02-15T13:30:00"
true
true
true
true
success,alert_schedule list
"1"
"12345"
"subscriber"
"1"
"2018-02-15T09:00:00"
"healthngoadmin1"
"Organizer"
"[1,2]"
"12345"
"67890"
"physician"
"2018-02-15T09:00:00"
"2018-02-15T17:00:00"
true
true
true
true
true
success,affiliation list
"1"
"12345"
"67890"
"physician"
"[monday"
"09:00:00"
"17:00:00"
"healthngoadmin1"
"Organizer"
"[67890,12121]"
"hospital"
"abc"
"+911234567890"
"info@xyz.com"
"www.abc.com"
false
true
true
true
true
true
success,entity list
"67890"
"hospital"
"abc"
"+911234567890"
"info@xyz.com"
"www.abc.com"
"healthngoadmin1"
"Organizer"
"[1,2]"
"67890"
"attendance"
"2018-02-15T11:00:00"
"2018-02-15T11:30:00"
true
true
true
true
true
true
true
success,log list
"1"
"resource"
"1"
"67890"
"attendance"
"2018-02-15T11:00:00"
"event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"
"healthngoadmin1"
"Organizer"
"abc medical camp"
"medical camp for senior citizens"
"doctor_consultation"
"67890"
"2018-02-15T11:00:00"
"2018-02-15T11:30:00"
"2018-02-15T11:10:00"
"1"
"non refundable"
"open"
"xyz"
"7th main"
"wilson garden"
"bangalore"
"karnataka"
"india"
"0.001"
"0.002"
success
ID of created event
"event_id:12345"
"healthngoadmin1"
"Organizer"
"true"
"1"
"subscriber"
"12345"
"67890"
"confirmed"
"2018-02-15T09:00:00"
"2018-02-15T17:00:00"
"true"
true
true
true
true
true
true
success,appointment_list
"1"
"true"
"1"
"subscriber"
"12345"
"confirmed"
"67890"
"healthngoadmin1"
"Organizer"
"[54321,31313]"
"psrk"
"doctor"
"+911234567890"
"abc@gmail.com"
"www.doctor1.com"
" phone"
"www.doctor1.com"
true
true
true
true
true
true
true
true
success,resource list
"54321"
"psrk"
"doctor"
"+911234567890"
"doctor1@xyz.com"
"psrk@gmail.com"
"phone"
"www.doctor1.com"
"healthngoadmin1"
"Organizer"
"[12345, 41414]"
"patient"
"abc"
"+911234567890"
"abc@gmail.com"
"www.abc.com"
" phone"
"www.abc.com"
true
true
true
true
true
true
true
true
success,message list
"12345"
"abc"
"patient"
"+911234567890"
"abc@gmail.com"
"www.abc.com"
"phone"
"www.abc.com"
"healthngoadmin1"
"Organizer"
"[12345,51515]"
"medical camp for senior citizens"
"doctor_consultation"
"opd_physician_consultation"
"67890"
"1"
"non refundable"
"2018-02-15T09:00:00"
"2018-02-15T17:00:00"
"xyz"
"7th main"
"wilson garden"
"bangalore"
"karnataka"
"india"
"0.001"
"0.002"
true
true
true
true
true
true
true
true
true
true
true
success,event_list
"12345"
"abc medical camp"
"medical camp for senior citizens"
"doctor_consultation"
"67890"
"2018-02-15T11:00:00"
"2018-02-15T11:30:00"
"2018-02-15T11:10:00"
"1"
"non refundable"
"open"
"xyz"
"7th main"
"wilson garden"
"bangalore"
"karnataka"
"india"
"0.001"
"0.002"