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.
healthngoadmin1Organizersuccess
ID of created event
event_id:12345Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//event/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
event_id:12345healthngoadmin1Organizer12345success, event updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//event/modifications?requestor_id=healthngoadmin1&request_token=Organizer&event_id=12345&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer12345success, event cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//event?requestor_id=healthngoadmin1&request_token=Organizer&event_id=12345 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,event_list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//event/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"event_id": "12345",
"details": {
"name": "abc medical camp",
"description": "medical camp for senior citizens",
"category": "doctor_consultation",
"host_entity_id": "67890",
"from": "2018-02-15T11:00:00",
"to": "2018-02-15T11:30:00",
"deadline": "2018-02-15T11:10:00",
"subscriber_limit": "1",
"terms": "non refundable",
"status": "open",
"venue": {
"building": "xyz",
"street": "7th main",
"area": "wilson garden",
"city": "bangalore",
"state": "karnataka",
"country": "india",
"lat": "0.001",
"long": "0.002"
}
}
}
]
]healthngoadmin1Organizersuccess
ID of created entity
entity_name:xyz hospital,entity_id:67890Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
entity_name:xyz hospital,entity_id:67890healthngoadmin1Organizer67890success, entity updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/modifications?requestor_id=healthngoadmin1&request_token=Organizer&entity_id=67890&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer67890success, entity cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//entity?requestor_id=healthngoadmin1&request_token=Organizer&entity_id=67890 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,entity list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"entity_id": "67890",
"details": {
"category": "hospital",
"name": "abc",
"phone": "+911234567890",
"email": "[email protected]",
"website": "www.abc.com"
}
}
]
]healthngoadmin1Organizersuccess
ID of created alert_schedule
alert_schedule_name:xyz hospital,alert_schedule_id:1Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
alert_schedule_name:xyz hospital,alert_schedule_id:1healthngoadmin1Organizer1success, alert_schedule updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/modifications?requestor_id=healthngoadmin1&request_token=text&alert_schedule_id=1&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer1success, alert_schedule cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule?requestor_id=healthngoadmin1&request_token=Organizer&alert_schedule_id=1 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,alert_schedule list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"alert_schedule_id": "1",
"details": {
"event_id": "12345",
"target_category": "subscriber",
"message_id": "1",
"alert_datetime": "2018-02-15T09:00:00"
}
}
]
]healthngoadmin1Organizersuccess
ID of created message
message_name:xyz hospital,message_id:1Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//message/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
message_name:xyz hospital,message_id:1healthngoadmin1Organizer1success, message updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//message/modifications?requestor_id=healthngoadmin1&request_token=Organizer&message_id=1&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer1success, message cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//message?requestor_id=healthngoadmin1&request_token=Organizer&message_id=1 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,message list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//message/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"message_id": "1",
"details": {
"entity_id": "67890",
"category": "reminder",
"message_body": "you have doctor consultation today"
}
}
]
]healthngoadmin1Organizersuccess
ID of created resource
resource_name:xyz hospital,resource_id:54321Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
resource_name:xyz hospital,resource_id:54321healthngoadmin1Organizer54321success, resource updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/modifications?requestor_id=healthngoadmin1&request_token=Organizer&resource_id=54321&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer54321success, resource cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//resource?requestor_id=healthngoadmin1&request_token=Organizer&resource_id=54321 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,resource list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"resource_id": "54321",
"details": {
"name": "psrk",
"category": "doctor",
"phone": "+911234567890",
"email": "[email protected]",
"alert_url": "[email protected]",
"alert_preference": "phone",
"status_poll_url": "www.doctor1.com"
}
}
]
]healthngoadmin1Organizersuccess,resource list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/availability?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"resource_id": "1",
"resource_name": "abc",
"free_slots": [
"{[2018-02-15T11:00:00to2018-02-15T11:09:00:00],[2018-02-22T11:00:00to2018-02-22T11:17:00:00]}"
]
}
]
]healthngoadmin1Organizersuccess
ID of created subscriber
subscriber_name:xyz hospital,subscriber_id:12345Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
subscriber_name:xyz hospital,subscriber_id:12345healthngoadmin1Organizer12345success, subscriber updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/modifications?requestor_id=healthngoadmin1&request_token=Organizer&subscriber_id=12345&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer12345success, subscriber cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber?requestor_id=healthngoadmin1&request_token=Organizer&subscriber_id=12345 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,message list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"subscriber_id": "12345",
"details": {
"name": "abc",
"category": "patient",
"phone": "+911234567890",
"email": "[email protected]",
"alert_url": "www.abc.com",
"alert_preference": "phone",
"status_poll_url": "www.abc.com"
}
}
]
]healthngoadmin1Organizersuccess
ID of created affiliation
affiliation_name:xyz hospital,affiliation_id:1Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
affiliation_name:xyz hospital,affiliation_id:1healthngoadmin1Organizer1success, affiliation updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/modifications?requestor_id=healthngoadmin1&request_token=Organizer&affiliation_id=1&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer1success, affiliation cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation?requestor_id=healthngoadmin1&request_token=Organizer&affiliation_id=1 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,affiliation list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"affiliation_id": "1",
"details": {
"resource_id": "12345",
"entity_id": "67890",
"resource_category": "physician",
"work_days_hours": [
{
"day_of_week": "[monday",
"start_time": "09:00:00",
"end_time": "17:00:00"
}
]
}
}
]
]healthngoadmin1Organizersuccess
ID of created appointment
[Event_id:12345,appointment_id:1]Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[Event_id:12345,appointment_id:1]healthngoadmin1Organizer1success, appointment updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/modifications?requestor_id=healthngoadmin1&request_token=Organizer&appointment_id=1&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer1success, appointment cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment?requestor_id=healthngoadmin1&request_token=Organizer&appointment_id=1 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,appointment_list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"appointment_id": "1",
"details": {
"exclusive": "true",
"event_id": "1",
"participant_type": "subscriber",
"participant_id": "12345",
"status_id": "confirmed",
"participant_entity_id": "67890"
}
}
]
]healthngoadmin1Organizersuccess
ID of created log
log_name:xyz hospital,log_id:1Invalid request
No permission
one or more specified inputs not found
Unexpected error
POST /r1/eGovStack/COM/11222456/SchedulerBB/creg//log/new?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
log_name:xyz hospital,log_id:1healthngoadmin1Organizer1success, log updated
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
PUT /r1/eGovStack/COM/11222456/SchedulerBB/creg//log/modifications?requestor_id=healthngoadmin1&request_token=Organizer&log_id=1&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizer1success, log cancelled
No content
Invalid request
No permission
one or more specified inputs not found
Unexpected error
DELETE /r1/eGovStack/COM/11222456/SchedulerBB/creg//log?requestor_id=healthngoadmin1&request_token=Organizer&log_id=1 HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
No content
healthngoadmin1Organizersuccess,log list
Invalid request
No permission
one or more specified inputs not found
Unexpected error
GET /r1/eGovStack/COM/11222456/SchedulerBB/creg//log/list_details?requestor_id=healthngoadmin1&request_token=Organizer&qry=[object+Object] HTTP/1.1
Host: ss2.egovstack.net
Accept: */*
[
[
{
"log_id": "1",
"details": {
"logger_role": "resource",
"logger_id": "1",
"entity_id": "67890",
"log_category": "attendance",
"datetime": "2018-02-15T11:00:00",
"log_data": "event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"
}
}
]
]