1 of 1

8 Service APIs

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.

8.1 Event Management

8.2 Entity Management

8.3 Alert Schedule Management

8.4 Alert Message Management

8.5 Resource management

8.6 Subscriber management

8.7 Affiliation management

8.8 Appointment management

8.9 Status Logging and Reporting

4.10 Information Mediator Interface

These Service APIs are not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.

4.11 PubSub Interface

These 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.
For implementation purposes, it is suggested to refer TMF630_REST_API_Design_Guidelines.

8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block.

The tests for the Scheduler Building Block can be found in this GitHub repository.

8.1 Event Management

create a new event, in event_list with given event_details, returns new event id or failure error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*event_new_qry (object)

detailsevent_creation_details (object)

namestring

Example: "abc medical camp"

descriptionstring

Example: "medical camp for senior citizens"

categorystring

Example: "doctor_consultation"

host_entity_idstring

Example: "67890"

slotsarray of object

fromstring (date-time)

Example: "2018-02-15T11:00:00"

tostring (date-time)

Example: "2018-02-15T11:30:00"

deadlinestring (date-time)

Example: "2018-02-15T11:10:00"

subscriber_limitstring

Example: "1"

termsstring

Example: "non refundable"

statusstring

Example: "open"

venuevenue (object)

buildingstring

Example: "xyz"

streetstring

Example: "7th main"

areastring

Example: "wilson garden"

citystring

Example: "bangalore"

statestring

Example: "karnataka"

countrystring

Example: "india"

latstring

Example: "0.001"

longstring

Example: "0.002"

Response

success

Body

string

ID of created event

Example: "event_id:12345"

Request

Response

changes values of specific details (as given by event_details) of given event (selected by event_filter)in event_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

event_id*string

Example: "12345"

qry*event_modify_qry (object)

detailsevent_details (object)

namestring

Example: "abc medical camp"

descriptionstring

Example: "medical camp for senior citizens"

categorystring

Example: "doctor_consultation"

host_entity_idstring

Example: "67890"

fromstring (date-time)

Example: "2018-02-15T11:00:00"

tostring (date-time)

Example: "2018-02-15T11:30:00"

deadlinestring (date-time)

Example: "2018-02-15T11:10:00"

subscriber_limitstring

Example: "1"

termsstring

Example: "non refundable"

statusstring

Example: "open"

venuevenue (object)

buildingstring

Example: "xyz"

streetstring

Example: "7th main"

areastring

Example: "wilson garden"

citystring

Example: "bangalore"

statestring

Example: "karnataka"

countrystring

Example: "india"

latstring

Example: "0.001"

longstring

Example: "0.002"

Response

success, event updated

Request

delete a predefined event in event_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

event_id*string

Example: "12345"

Response

success, event cancelled

Request

get list of events filetered by criteria in event_filter and return info specified by event_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*event_get_details_qry (object)

event_filterevent_filter (object)

event_idarray of string

Example: "[12345,51515]"

itemsstring

descriptionstring

Example: "medical camp for senior citizens"

namestring

Example: "doctor_consultation"

categorystring

Example: "opd_physician_consultation"

host_entity_idstring

Example: "67890"

subscriber_limitstring

Example: "1"

termsstring

Example: "non refundable"

fromstring (date-time)

Example: "2018-02-15T09:00:00"

tostring (date-time)

Example: "2018-02-15T17:00:00"

venuevenue (object)

buildingstring

Example: "xyz"

streetstring

Example: "7th main"

areastring

Example: "wilson garden"

citystring

Example: "bangalore"

statestring

Example: "karnataka"

countrystring

Example: "india"

latstring

Example: "0.001"

longstring

Example: "0.002"

event_details_requiredevent_details_required (object)

event_idboolean

Example: true

descriptionboolean

Example: true

nameboolean

Example: true

categoryboolean

Example: true

host_entity_idboolean

Example: true

periodboolean

Example: true

venueboolean

Example: true

deadlineboolean

Example: true

subscriber_limitboolean

Example: true

termsboolean

Example: true

statusboolean

Example: true

Response

success,event_list

Body

event_idstring

Example: "12345"

detailsevent_details (object)

namestring

Example: "abc medical camp"

descriptionstring

Example: "medical camp for senior citizens"

categorystring

Example: "doctor_consultation"

host_entity_idstring

Example: "67890"

fromstring (date-time)

Example: "2018-02-15T11:00:00"

tostring (date-time)

Example: "2018-02-15T11:30:00"

deadlinestring (date-time)

Example: "2018-02-15T11:10:00"

subscriber_limitstring

Example: "1"

termsstring

Example: "non refundable"

statusstring

Example: "open"

venuevenue (object)

buildingstring

Example: "xyz"

streetstring

Example: "7th main"

areastring

Example: "wilson garden"

citystring

Example: "bangalore"

statestring

Example: "karnataka"

countrystring

Example: "india"

latstring

Example: "0.001"

longstring

Example: "0.002"

Request

Response

8.2 Entity Management

create a new entity, in entity_list with given entity_details, returns new entity id or entity error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*entity_new_qry (object)

detailsentity_details (object)

categorystring

Example: "hospital"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "info@xyz.com"

websitestring (url)

Example: "www.abc.com"

Response

success

Body

string

ID of created entity

Example: "entity_name:xyz hospital,entity_id:67890"

Request

Response

changes values of specific details (as given by entity_details) of given entity (selected by entity_filter)in entity_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

entity_id*string

Example: "67890"

qry*entity_modify_qry (object)

detailsentity_details (object)

categorystring

Example: "hospital"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "info@xyz.com"

websitestring (url)

Example: "www.abc.com"

Response

success, entity updated

Request

delete a predefined entity in entity_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

entity_id*string

Example: "67890"

Response

success, entity cancelled

Request

get list of entities filetered by criteria in entity_filter and return info specified by entity_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*entity_get_details_qry (object)

entity_filterentity_filter (object)

entity_idarray of string

Example: "[67890,12121]"

itemsstring

categorystring

Example: "hospital"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "info@xyz.com"

websitestring (url)

Example: "www.abc.com"

entity_details_requiredentity_details_required (object)

entity_idboolean

Example: false

categoryboolean

Example: true

nameboolean

Example: true

phoneboolean

Example: true

emailboolean

Example: true

websiteboolean

Example: true

Response

success,entity list

Body

entity_idstring

Example: "67890"

detailsentity_details (object)

categorystring

Example: "hospital"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "info@xyz.com"

websitestring (url)

Example: "www.abc.com"

Request

Response

8.3 Alert Schedule Management

create a new alert_schedule, in alert_schedule_list with given alert_schedule_details, returns new alert_schedule id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*alert_schedule_new_qry (object)

alert_schedule_detailsalert_schedule_details (object)

event_idstring

Example: "12345"

target_categorystring

Example: "subscriber"

message_idstring

Example: "1"

alert_datetimestring (date-time)

Example: "2018-02-15T09:00:00"

Response

success

Body

string

ID of created alert_schedule

Example: "alert_schedule_name:xyz hospital,alert_schedule_id:1"

Request

Response

changes values of specific details (as given by alert_schedule_details) of given alert_schedule (selected by alert_schedule_filter)in alert_schedule_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

alert_schedule_id*string

Example: "1"

qry*alert_schedule_modify_qry (object)

detailsalert_schedule_details (object)

event_idstring

Example: "12345"

target_categorystring

Example: "subscriber"

message_idstring

Example: "1"

alert_datetimestring (date-time)

Example: "2018-02-15T09:00:00"

Response

success, alert_schedule updated

Request

delete a predefined alert_schedule in alert_schedule_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

alert_schedule_id*string

Example: "1"

Response

success, alert_schedule cancelled

Request

get list of entities filetered by criteria in alert_schedule_filter and return info specified by alert_schedule_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*alert_schedule_get_details_qry (object)

alert_schedule_filteralert_schedule_filter (object)

alert_schedule_idarray of string

Example: "[1,2]"

itemsstring

entity_idstring

Example: "67890"

target_categorystring

Example: "subscriber"

message_idstring

Example: "1"

fromstring (date-time)

Example: "2018-02-15T09:00:00"

tostring (date-time)

Example: "2018-02-15T13:30:00"

alert_schedule_details_requiredalert_schedule_details_required (object)

alert_schedule_idboolean

Example: true

entity_idboolean

Example: true

message_idboolean

Example: true

alert_datetimeboolean

Example: true

Response

success,alert_schedule list

Body

alert_schedule_idstring

Example: "1"

detailsalert_schedule_details (object)

event_idstring

Example: "12345"

target_categorystring

Example: "subscriber"

message_idstring

Example: "1"

alert_datetimestring (date-time)

Example: "2018-02-15T09:00:00"

Request

Response

8.4 Alert Message Management

create a new message, in message_list with given message_details, returns new message id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*message_new_qry (object)

message_detailsmessage_details (object)

entity_idstring

Example: "67890"

categorystring

Example: "reminder"

message_bodystring

Example: "you have doctor consultation today"

Response

success

Body

string

ID of created message

Example: "message_name:xyz hospital,message_id:1"

Request

Response

changes values of specific details (as given by message_details) of given message (selected by message_filter)in message_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

message_id*string

Example: "1"

qry*message_modify_qry (object)

detailsmessage_details (object)

entity_idstring

Example: "67890"

categorystring

Example: "reminder"

message_bodystring

Example: "you have doctor consultation today"

Response

success, message updated

Request

delete a predefined message in message_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

message_id*string

Example: "1"

Response

success, message cancelled

Request

get list of entities filetered by criteria in message_filter and return info specified by message_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*message_get_details_qry (object)

message_filtermessage_filter (object)

message_idarray of string

Example: "[1,2]"

itemsstring

entity_idstring

Example: "67890"

categorystring

Example: "reminder"

message_bodystring

Example: "you have doctor consultation today"

message_details_requiredmessage_details_required (object)

message_idboolean

Example: true

entity_idboolean

Example: true

categoryboolean

Example: true

message_bodyboolean

Example: true

Response

success,message list

Body

message_idstring

Example: "1"

detailsmessage_details (object)

entity_idstring

Example: "67890"

categorystring

Example: "reminder"

message_bodystring

Example: "you have doctor consultation today"

Request

Response

8.5 Resource management

create a new resource, in resource_list with given resource_details, returns new resource id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*resource_new_qry (object)

resource_detailsresource_details (object)

namestring

Example: "psrk"

categorystring

Example: "doctor"

phonestring

Example: "+911234567890"

emailstring

Example: "doctor1@xyz.com"

alert_urlstring (url)

Example: "psrk@gmail.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.doctor1.com"

Response

success

Body

string

ID of created resource

Example: "resource_name:xyz hospital,resource_id:54321"

Request

Response

changes values of specific details (as given by resource_details) of given resource (selected by resource_filter)in resource_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

resource_id*string

Example: "54321"

qry*resource_modify_qry (object)

detailsresource_details (object)

namestring

Example: "psrk"

categorystring

Example: "doctor"

phonestring

Example: "+911234567890"

emailstring

Example: "doctor1@xyz.com"

alert_urlstring (url)

Example: "psrk@gmail.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.doctor1.com"

Response

success, resource updated

Request

delete a predefined resource in resource_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

resource_id*string

Example: "54321"

Response

success, resource cancelled

Request

get list of entities filetered by criteria in resource_filter and return info specified by resource_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*resource_get_details_qry (object)

resource_filterresource_filter (object)

resource_idarray of string

Example: "[54321,31313]"

itemsstring

namestring

Example: "psrk"

categorystring

Example: "doctor"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.doctor1.com"

alert_preferencestring

Example: " phone"

status_poll_urlstring (url)

Example: "www.doctor1.com"

resource_details_requiredresource_details_required (object)

resource_idboolean

Example: true

nameboolean

Example: true

categoryboolean

Example: true

phoneboolean

Example: true

emailboolean

Example: true

alert_urlboolean

Example: true

alert_preferenceboolean

Example: true

status_poll_urlboolean

Example: true

Response

success,resource list

Body

resource_idstring

Example: "54321"

detailsresource_details (object)

namestring

Example: "psrk"

categorystring

Example: "doctor"

phonestring

Example: "+911234567890"

emailstring

Example: "doctor1@xyz.com"

alert_urlstring (url)

Example: "psrk@gmail.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.doctor1.com"

Request

Response

get details of resources matching criteria given by free_resource_filter, that are free(unallocated) in a given date range and entity and returns success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/availability

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*resource_get_availability_qry (object)

free_resource_filterfree_resource_filter (object)

categorystring

Example: "doctor"

Entity_idstring

Example: "67890"

fromstring (date-time)

Example: "2018-02-14T09:00:00"

tostring (date-time)

Example: "2018-02-18T13:30:00"

resource_idstring

Example: "1"

Response

success,resource list

Body

resource_idstring

Example: "1"

resource_namestring

Example: "abc"

free_slotsarray of string

itemsstring

Example: "{[2018-02-15T11:00:00to2018-02-15T11:09:00:00],[2018-02-22T11:00:00to2018-02-22T11:17:00:00]}"

Request

Response

8.6 Subscriber management

create a new subscriber, in subscriber_list with given subscriber_details, returns new subscriber id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*subscriber_new_qry (object)

subscriber_detailssubscriber_details (object)

namestring

Example: "abc"

categorystring

Example: "patient"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.abc.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.abc.com"

Response

success

Body

string

ID of created subscriber

Example: "subscriber_name:xyz hospital,subscriber_id:12345"

Request

Response

changes values of specific details (as given by subscriber_details) of given subscriber (selected by subscriber_filter)in subscriber_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

subscriber_id*string

Example: "12345"

qry*subscriber_modify_qry (object)

detailssubscriber_details (object)

namestring

Example: "abc"

categorystring

Example: "patient"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.abc.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.abc.com"

Response

success, subscriber updated

Request

delete a predefined subscriber in subscriber_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

subscriber_id*string

Example: "12345"

Response

success, subscriber cancelled

Request

get list of entities filetered by criteria in subscriber_filter and return info specified by subscriber_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*subscriber_get_details_qry (object)

subscriber_filtersubscriber_filter (object)

subscriber_idarray of string

Example: "[12345, 41414]"

itemsstring

categorystring

Example: "patient"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.abc.com"

alert_preferencestring

Example: " phone"

status_poll_urlstring (url)

Example: "www.abc.com"

subscriber_details_requiredsubscriber_details_required (object)

subscriber_idboolean

Example: true

categoryboolean

Example: true

nameboolean

Example: true

phoneboolean

Example: true

emailboolean

Example: true

alert_urlboolean

Example: true

alert_preferenceboolean

Example: true

status_poll_urlboolean

Example: true

Response

success,message list

Body

subscriber_idstring

Example: "12345"

detailssubscriber_details (object)

namestring

Example: "abc"

categorystring

Example: "patient"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.abc.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.abc.com"

Request

Response

8.7 Affiliation management

create a new affiliation, in affiliation_list with given affiliation_details, returns new affiliation id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*affiliation_new_qry (object)

affiliation_detailsaffiliation_details (object)

resource_idstring

Example: "12345"

entity_idstring

Example: "67890"

resource_categorystring

Example: "physician"

work_days_hoursdays_hours (array of object)

day_of_weekstring

Example: "[monday"

start_timestring

Example: "09:00:00"

end_timestring

Example: "17:00:00"

Response

success

Body

string

ID of created affiliation

Example: "affiliation_name:xyz hospital,affiliation_id:1"

Request

Response

changes values of specific details (as given by affiliation_details) of given affiliation (selected by affiliation_filter)in affiliation_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

affiliation_id*string

Example: "1"

qry*affiliation_modify_qry (object)

detailsaffiliation_details (object)

resource_idstring

Example: "12345"

entity_idstring

Example: "67890"

resource_categorystring

Example: "physician"

work_days_hoursdays_hours (array of object)

day_of_weekstring

Example: "[monday"

start_timestring

Example: "09:00:00"

end_timestring

Example: "17:00:00"

Response

success, affiliation updated

Request

delete a predefined affiliation in affiliation_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

affiliation_id*string

Example: "1"

Response

success, affiliation cancelled

Request

get list of entities filetered by criteria in affiliation_filter and return info specified by affiliation_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*affiliation_get_details_qry (object)

affiliation_filteraffiliation_filter (object)

affiliation_idarray of string

Example: "[1,2]"

itemsstring

resource_idstring

Example: "12345"

entity_idstring

Example: "67890"

categorystring

Example: "physician"

fromstring (date-time)

Example: "2018-02-15T09:00:00"

tostring (date-time)

Example: "2018-02-15T17:00:00"

affiliation_details_requiredaffiliation_details_required (object)

affiliation_idboolean

Example: true

resource_idboolean

Example: true

entity_idboolean

Example: true

categoryboolean

Example: true

work_days_hoursboolean

Example: true

Response

success,affiliation list

Body

affiliation_idstring

Example: "1"

detailsaffiliation_details (object)

resource_idstring

Example: "12345"

entity_idstring

Example: "67890"

resource_categorystring

Example: "physician"

work_days_hoursdays_hours (array of object)

day_of_weekstring

Example: "[monday"

start_timestring

Example: "09:00:00"

end_timestring

Example: "17:00:00"

Request

Response

8.8 Appointment management

create a new appointment, in appointment_list with given appointment_details, returns new appointment id or failure error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*appointment_new_qry (object)

appointment_detailsappointment_creation_details (object)

exclusiveboolean

Example: "true"

event_idsarray of string

Example: "[1]"

itemsstring

participant_typestring

Example: "subscriber"

participant_idstring

Example: "12345"

participant_entity_idstring

Example: "67890"

Response

success

Body

string

ID of created appointment

Example: "[Event_id:12345,appointment_id:1]"

Request

Response

changes values of specific details (as given by appointment_details) of given appointment (selected by appointment_filter)in appointment_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

appointment_id*string

Example: "1"

qry*appointment_modify_qry (object)

detailsappointment_details (object)

exclusiveboolean

Example: "true"

event_idstring

Example: "1"

participant_typestring

Example: "subscriber"

participant_idstring

Example: "12345"

status_idstring

Example: "confirmed"

participant_entity_idstring

Example: "67890"

Response

success, appointment updated

Request

delete a predefined appointment in appointment_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

appointment_id*string

Example: "1"

Response

success, appointment cancelled

Request

get list of appointments filetered by criteria in appointment_filter and return info specified by appointment_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*appointment_get_details_qry (object)

appointment_filterappointment_filter (object)

exclusiveboolean

Example: "true"

appointment_idstring

Example: "1"

participant_typestring

Example: "subscriber"

participant_idstring

Example: "12345"

participant_entity_idstring

Example: "67890"

statusstring

Example: "confirmed"

fromstring (date-time)

Example: "2018-02-15T09:00:00"

tostring (date-time)

Example: "2018-02-15T17:00:00"

appointment_details_requiredappointment_details_required (object)

exclusiveboolean

Example: "true"

appointment_idboolean

Example: true

event_detailsboolean

Example: true

participant_typeboolean

Example: true

participant_idboolean

Example: true

statusboolean

Example: true

participant_entity_idboolean

Example: true

Response

success,appointment_list

Body

appointment_idstring

Example: "1"

detailsappointment_details (object)

exclusiveboolean

Example: "true"

event_idstring

Example: "1"

participant_typestring

Example: "subscriber"

participant_idstring

Example: "12345"

status_idstring

Example: "confirmed"

participant_entity_idstring

Example: "67890"

Request

Response

8.9 Status Logging and Reporting

create a new log, in log_list with given log_details, returns new log id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*log_new_qry (object)

log_detailslog_details (object)

logger_rolestring

Example: "resource"

logger_idstring

Example: "1"

entity_idstring

Example: "67890"

log_categorystring

Example: "attendance"

datetimestring (date-time)

Example: "2018-02-15T11:00:00"

log_datastring

Example: "event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"

Response

success

Body

string

ID of created log

Example: "log_name:xyz hospital,log_id:1"

Request

Response

changes values of specific details (as given by log_details) of given log (selected by log_filter)in log_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

log_id*string

Example: "1"

qry*log_modify_qry (object)

detailslog_details (object)

logger_rolestring

Example: "resource"

logger_idstring

Example: "1"

entity_idstring

Example: "67890"

log_categorystring

Example: "attendance"

datetimestring (date-time)

Example: "2018-02-15T11:00:00"

log_datastring

Example: "event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"

Response

success, log updated

Request

delete a predefined log in log_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

log_id*string

Example: "1"

Response

success, log cancelled

Request

get list of entities filetered by criteria in log_filter and return info specified by log_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*log_get_details_qry (object)

log_filterlog_filter (object)

log_idarray of string

Example: "[1,2]"

itemsstring

entity_idstring

Example: "67890"

categorystring

Example: "attendance"

fromstring (date-time)

Example: "2018-02-15T11:00:00"

tostring (date-time)

Example: "2018-02-15T11:30:00"

log_details_requiredlog_details_required (object)

log_idboolean

Example: true

logger_categoryboolean

Example: true

logger_idboolean

Example: true

entity_idboolean

Example: true

log_categoryboolean

Example: true

datetimeboolean

Example: true

log_databoolean

Example: true

Response

success,log list

Body

log_idstring

Example: "1"

detailslog_details (object)

logger_rolestring

Example: "resource"

logger_idstring

Example: "1"

entity_idstring

Example: "67890"

log_categorystring

Example: "attendance"

datetimestring (date-time)

Example: "2018-02-15T11:00:00"

log_datastring

Example: "event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"

Request

Response

4.10 Information Mediator Interface

These Service APIs are not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.

4.11 PubSub Interface

These 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.
For implementation purposes, it is suggested to refer TMF630_REST_API_Design_Guidelines.

delete a predefined alert_schedule in alert_schedule_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

alert_schedule_id*string

Example: "1"

Response

success, alert_schedule cancelled

Request

delete a predefined resource in resource_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

resource_id*string

Example: "54321"

Response

success, resource cancelled

Request

delete a predefined subscriber in subscriber_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

subscriber_id*string

Example: "12345"

Response

success, subscriber cancelled

Request

delete a predefined affiliation in affiliation_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

affiliation_id*string

Example: "1"

Response

success, affiliation cancelled

Request

delete a predefined appointment in appointment_list and returns success or error code

DELETEhttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

appointment_id*string

Example: "1"

Response

success, appointment cancelled

Request

changes values of specific details (as given by message_details) of given message (selected by message_filter)in message_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

message_id*string

Example: "1"

qry*message_modify_qry (object)

detailsmessage_details (object)

entity_idstring

Example: "67890"

categorystring

Example: "reminder"

message_bodystring

Example: "you have doctor consultation today"

Response

success, message updated

Request

changes values of specific details (as given by affiliation_details) of given affiliation (selected by affiliation_filter)in affiliation_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

affiliation_id*string

Example: "1"

qry*affiliation_modify_qry (object)

detailsaffiliation_details (object)

resource_idstring

Example: "12345"

entity_idstring

Example: "67890"

resource_categorystring

Example: "physician"

work_days_hoursdays_hours (array of object)

day_of_weekstring

Example: "[monday"

start_timestring

Example: "09:00:00"

end_timestring

Example: "17:00:00"

Response

success, affiliation updated

Request

changes values of specific details (as given by alert_schedule_details) of given alert_schedule (selected by alert_schedule_filter)in alert_schedule_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

alert_schedule_id*string

Example: "1"

qry*alert_schedule_modify_qry (object)

detailsalert_schedule_details (object)

event_idstring

Example: "12345"

target_categorystring

Example: "subscriber"

message_idstring

Example: "1"

alert_datetimestring (date-time)

Example: "2018-02-15T09:00:00"

Response

success, alert_schedule updated

Request

changes values of specific details (as given by entity_details) of given entity (selected by entity_filter)in entity_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

entity_id*string

Example: "67890"

qry*entity_modify_qry (object)

detailsentity_details (object)

categorystring

Example: "hospital"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "info@xyz.com"

websitestring (url)

Example: "www.abc.com"

Response

success, entity updated

Request

create a new message, in message_list with given message_details, returns new message id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*message_new_qry (object)

message_detailsmessage_details (object)

entity_idstring

Example: "67890"

categorystring

Example: "reminder"

message_bodystring

Example: "you have doctor consultation today"

Response

success

Body

string

ID of created message

Example: "message_name:xyz hospital,message_id:1"

Request

Response

changes values of specific details (as given by appointment_details) of given appointment (selected by appointment_filter)in appointment_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

appointment_id*string

Example: "1"

qry*appointment_modify_qry (object)

detailsappointment_details (object)

exclusiveboolean

Example: "true"

event_idstring

Example: "1"

participant_typestring

Example: "subscriber"

participant_idstring

Example: "12345"

status_idstring

Example: "confirmed"

participant_entity_idstring

Example: "67890"

Response

success, appointment updated

Request

changes values of specific details (as given by log_details) of given log (selected by log_filter)in log_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

log_id*string

Example: "1"

qry*log_modify_qry (object)

detailslog_details (object)

logger_rolestring

Example: "resource"

logger_idstring

Example: "1"

entity_idstring

Example: "67890"

log_categorystring

Example: "attendance"

datetimestring (date-time)

Example: "2018-02-15T11:00:00"

log_datastring

Example: "event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"

Response

success, log updated

Request

create a new alert_schedule, in alert_schedule_list with given alert_schedule_details, returns new alert_schedule id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*alert_schedule_new_qry (object)

alert_schedule_detailsalert_schedule_details (object)

event_idstring

Example: "12345"

target_categorystring

Example: "subscriber"

message_idstring

Example: "1"

alert_datetimestring (date-time)

Example: "2018-02-15T09:00:00"

Response

success

Body

string

ID of created alert_schedule

Example: "alert_schedule_name:xyz hospital,alert_schedule_id:1"

Request

Response

changes values of specific details (as given by resource_details) of given resource (selected by resource_filter)in resource_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

resource_id*string

Example: "54321"

qry*resource_modify_qry (object)

detailsresource_details (object)

namestring

Example: "psrk"

categorystring

Example: "doctor"

phonestring

Example: "+911234567890"

emailstring

Example: "doctor1@xyz.com"

alert_urlstring (url)

Example: "psrk@gmail.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.doctor1.com"

Response

success, resource updated

Request

changes values of specific details (as given by subscriber_details) of given subscriber (selected by subscriber_filter)in subscriber_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

subscriber_id*string

Example: "12345"

qry*subscriber_modify_qry (object)

detailssubscriber_details (object)

namestring

Example: "abc"

categorystring

Example: "patient"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.abc.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.abc.com"

Response

success, subscriber updated

Request

create a new entity, in entity_list with given entity_details, returns new entity id or entity error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*entity_new_qry (object)

detailsentity_details (object)

categorystring

Example: "hospital"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "info@xyz.com"

websitestring (url)

Example: "www.abc.com"

Response

success

Body

string

ID of created entity

Example: "entity_name:xyz hospital,entity_id:67890"

Request

Response

create a new appointment, in appointment_list with given appointment_details, returns new appointment id or failure error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*appointment_new_qry (object)

appointment_detailsappointment_creation_details (object)

exclusiveboolean

Example: "true"

event_idsarray of string

Example: "[1]"

itemsstring

participant_typestring

Example: "subscriber"

participant_idstring

Example: "12345"

participant_entity_idstring

Example: "67890"

Response

success

Body

string

ID of created appointment

Example: "[Event_id:12345,appointment_id:1]"

Request

Response

create a new log, in log_list with given log_details, returns new log id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*log_new_qry (object)

log_detailslog_details (object)

logger_rolestring

Example: "resource"

logger_idstring

Example: "1"

entity_idstring

Example: "67890"

log_categorystring

Example: "attendance"

datetimestring (date-time)

Example: "2018-02-15T11:00:00"

log_datastring

Example: "event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"

Response

success

Body

string

ID of created log

Example: "log_name:xyz hospital,log_id:1"

Request

Response

create a new resource, in resource_list with given resource_details, returns new resource id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*resource_new_qry (object)

resource_detailsresource_details (object)

namestring

Example: "psrk"

categorystring

Example: "doctor"

phonestring

Example: "+911234567890"

emailstring

Example: "doctor1@xyz.com"

alert_urlstring (url)

Example: "psrk@gmail.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.doctor1.com"

Response

success

Body

string

ID of created resource

Example: "resource_name:xyz hospital,resource_id:54321"

Request

Response

create a new subscriber, in subscriber_list with given subscriber_details, returns new subscriber id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*subscriber_new_qry (object)

subscriber_detailssubscriber_details (object)

namestring

Example: "abc"

categorystring

Example: "patient"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.abc.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.abc.com"

Response

success

Body

string

ID of created subscriber

Example: "subscriber_name:xyz hospital,subscriber_id:12345"

Request

Response

create a new affiliation, in affiliation_list with given affiliation_details, returns new affiliation id or error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*affiliation_new_qry (object)

affiliation_detailsaffiliation_details (object)

resource_idstring

Example: "12345"

entity_idstring

Example: "67890"

resource_categorystring

Example: "physician"

work_days_hoursdays_hours (array of object)

day_of_weekstring

Example: "[monday"

start_timestring

Example: "09:00:00"

end_timestring

Example: "17:00:00"

Response

success

Body

string

ID of created affiliation

Example: "affiliation_name:xyz hospital,affiliation_id:1"

Request

Response

get details of resources matching criteria given by free_resource_filter, that are free(unallocated) in a given date range and entity and returns success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/availability

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*resource_get_availability_qry (object)

free_resource_filterfree_resource_filter (object)

categorystring

Example: "doctor"

Entity_idstring

Example: "67890"

fromstring (date-time)

Example: "2018-02-14T09:00:00"

tostring (date-time)

Example: "2018-02-18T13:30:00"

resource_idstring

Example: "1"

Response

success,resource list

Body

resource_idstring

Example: "1"

resource_namestring

Example: "abc"

free_slotsarray of string

itemsstring

Example: "{[2018-02-15T11:00:00to2018-02-15T11:09:00:00],[2018-02-22T11:00:00to2018-02-22T11:17:00:00]}"

Request

Response

get list of entities filetered by criteria in message_filter and return info specified by message_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*message_get_details_qry (object)

message_filtermessage_filter (object)

message_idarray of string

Example: "[1,2]"

itemsstring

entity_idstring

Example: "67890"

categorystring

Example: "reminder"

message_bodystring

Example: "you have doctor consultation today"

message_details_requiredmessage_details_required (object)

message_idboolean

Example: true

entity_idboolean

Example: true

categoryboolean

Example: true

message_bodyboolean

Example: true

Response

success,message list

Body

message_idstring

Example: "1"

detailsmessage_details (object)

entity_idstring

Example: "67890"

categorystring

Example: "reminder"

message_bodystring

Example: "you have doctor consultation today"

Request

Response

changes values of specific details (as given by event_details) of given event (selected by event_filter)in event_list and returns success or error code

PUThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/modifications

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

event_id*string

Example: "12345"

qry*event_modify_qry (object)

detailsevent_details (object)

namestring

Example: "abc medical camp"

descriptionstring

Example: "medical camp for senior citizens"

categorystring

Example: "doctor_consultation"

host_entity_idstring

Example: "67890"

fromstring (date-time)

Example: "2018-02-15T11:00:00"

tostring (date-time)

Example: "2018-02-15T11:30:00"

deadlinestring (date-time)

Example: "2018-02-15T11:10:00"

subscriber_limitstring

Example: "1"

termsstring

Example: "non refundable"

statusstring

Example: "open"

venuevenue (object)

buildingstring

Example: "xyz"

streetstring

Example: "7th main"

areastring

Example: "wilson garden"

citystring

Example: "bangalore"

statestring

Example: "karnataka"

countrystring

Example: "india"

latstring

Example: "0.001"

longstring

Example: "0.002"

Response

success, event updated

Request

get list of entities filetered by criteria in alert_schedule_filter and return info specified by alert_schedule_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*alert_schedule_get_details_qry (object)

alert_schedule_filteralert_schedule_filter (object)

alert_schedule_idarray of string

Example: "[1,2]"

itemsstring

entity_idstring

Example: "67890"

target_categorystring

Example: "subscriber"

message_idstring

Example: "1"

fromstring (date-time)

Example: "2018-02-15T09:00:00"

tostring (date-time)

Example: "2018-02-15T13:30:00"

alert_schedule_details_requiredalert_schedule_details_required (object)

alert_schedule_idboolean

Example: true

entity_idboolean

Example: true

message_idboolean

Example: true

alert_datetimeboolean

Example: true

Response

success,alert_schedule list

Body

alert_schedule_idstring

Example: "1"

detailsalert_schedule_details (object)

event_idstring

Example: "12345"

target_categorystring

Example: "subscriber"

message_idstring

Example: "1"

alert_datetimestring (date-time)

Example: "2018-02-15T09:00:00"

Request

Response

get list of entities filetered by criteria in affiliation_filter and return info specified by affiliation_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*affiliation_get_details_qry (object)

affiliation_filteraffiliation_filter (object)

affiliation_idarray of string

Example: "[1,2]"

itemsstring

resource_idstring

Example: "12345"

entity_idstring

Example: "67890"

categorystring

Example: "physician"

fromstring (date-time)

Example: "2018-02-15T09:00:00"

tostring (date-time)

Example: "2018-02-15T17:00:00"

affiliation_details_requiredaffiliation_details_required (object)

affiliation_idboolean

Example: true

resource_idboolean

Example: true

entity_idboolean

Example: true

categoryboolean

Example: true

work_days_hoursboolean

Example: true

Response

success,affiliation list

Body

affiliation_idstring

Example: "1"

detailsaffiliation_details (object)

resource_idstring

Example: "12345"

entity_idstring

Example: "67890"

resource_categorystring

Example: "physician"

work_days_hoursdays_hours (array of object)

day_of_weekstring

Example: "[monday"

start_timestring

Example: "09:00:00"

end_timestring

Example: "17:00:00"

Request

Response

get list of entities filetered by criteria in entity_filter and return info specified by entity_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*entity_get_details_qry (object)

entity_filterentity_filter (object)

entity_idarray of string

Example: "[67890,12121]"

itemsstring

categorystring

Example: "hospital"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "info@xyz.com"

websitestring (url)

Example: "www.abc.com"

entity_details_requiredentity_details_required (object)

entity_idboolean

Example: false

categoryboolean

Example: true

nameboolean

Example: true

phoneboolean

Example: true

emailboolean

Example: true

websiteboolean

Example: true

Response

success,entity list

Body

entity_idstring

Example: "67890"

detailsentity_details (object)

categorystring

Example: "hospital"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "info@xyz.com"

websitestring (url)

Example: "www.abc.com"

Request

Response

get list of entities filetered by criteria in log_filter and return info specified by log_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*log_get_details_qry (object)

log_filterlog_filter (object)

log_idarray of string

Example: "[1,2]"

itemsstring

entity_idstring

Example: "67890"

categorystring

Example: "attendance"

fromstring (date-time)

Example: "2018-02-15T11:00:00"

tostring (date-time)

Example: "2018-02-15T11:30:00"

log_details_requiredlog_details_required (object)

log_idboolean

Example: true

logger_categoryboolean

Example: true

logger_idboolean

Example: true

entity_idboolean

Example: true

log_categoryboolean

Example: true

datetimeboolean

Example: true

log_databoolean

Example: true

Response

success,log list

Body

log_idstring

Example: "1"

detailslog_details (object)

logger_rolestring

Example: "resource"

logger_idstring

Example: "1"

entity_idstring

Example: "67890"

log_categorystring

Example: "attendance"

datetimestring (date-time)

Example: "2018-02-15T11:00:00"

log_datastring

Example: "event_id:12345,subscriber_id:1,token:a2s3x2fer,status:attended"

Request

Response

create a new event, in event_list with given event_details, returns new event id or failure error code

POSThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/new

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*event_new_qry (object)

detailsevent_creation_details (object)

namestring

Example: "abc medical camp"

descriptionstring

Example: "medical camp for senior citizens"

categorystring

Example: "doctor_consultation"

host_entity_idstring

Example: "67890"

slotsarray of object

fromstring (date-time)

Example: "2018-02-15T11:00:00"

tostring (date-time)

Example: "2018-02-15T11:30:00"

deadlinestring (date-time)

Example: "2018-02-15T11:10:00"

subscriber_limitstring

Example: "1"

termsstring

Example: "non refundable"

statusstring

Example: "open"

venuevenue (object)

buildingstring

Example: "xyz"

streetstring

Example: "7th main"

areastring

Example: "wilson garden"

citystring

Example: "bangalore"

statestring

Example: "karnataka"

countrystring

Example: "india"

latstring

Example: "0.001"

longstring

Example: "0.002"

Response

success

Body

string

ID of created event

Example: "event_id:12345"

Request

Response

get list of appointments filetered by criteria in appointment_filter and return info specified by appointment_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*appointment_get_details_qry (object)

appointment_filterappointment_filter (object)

exclusiveboolean

Example: "true"

appointment_idstring

Example: "1"

participant_typestring

Example: "subscriber"

participant_idstring

Example: "12345"

participant_entity_idstring

Example: "67890"

statusstring

Example: "confirmed"

fromstring (date-time)

Example: "2018-02-15T09:00:00"

tostring (date-time)

Example: "2018-02-15T17:00:00"

appointment_details_requiredappointment_details_required (object)

exclusiveboolean

Example: "true"

appointment_idboolean

Example: true

event_detailsboolean

Example: true

participant_typeboolean

Example: true

participant_idboolean

Example: true

statusboolean

Example: true

participant_entity_idboolean

Example: true

Response

success,appointment_list

Body

appointment_idstring

Example: "1"

detailsappointment_details (object)

exclusiveboolean

Example: "true"

event_idstring

Example: "1"

participant_typestring

Example: "subscriber"

participant_idstring

Example: "12345"

status_idstring

Example: "confirmed"

participant_entity_idstring

Example: "67890"

Request

Response

get list of entities filetered by criteria in resource_filter and return info specified by resource_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*resource_get_details_qry (object)

resource_filterresource_filter (object)

resource_idarray of string

Example: "[54321,31313]"

itemsstring

namestring

Example: "psrk"

categorystring

Example: "doctor"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.doctor1.com"

alert_preferencestring

Example: " phone"

status_poll_urlstring (url)

Example: "www.doctor1.com"

resource_details_requiredresource_details_required (object)

resource_idboolean

Example: true

nameboolean

Example: true

categoryboolean

Example: true

phoneboolean

Example: true

emailboolean

Example: true

alert_urlboolean

Example: true

alert_preferenceboolean

Example: true

status_poll_urlboolean

Example: true

Response

success,resource list

Body

resource_idstring

Example: "54321"

detailsresource_details (object)

namestring

Example: "psrk"

categorystring

Example: "doctor"

phonestring

Example: "+911234567890"

emailstring

Example: "doctor1@xyz.com"

alert_urlstring (url)

Example: "psrk@gmail.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.doctor1.com"

Request

Response

get list of entities filetered by criteria in subscriber_filter and return info specified by subscriber_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*subscriber_get_details_qry (object)

subscriber_filtersubscriber_filter (object)

subscriber_idarray of string

Example: "[12345, 41414]"

itemsstring

categorystring

Example: "patient"

namestring

Example: "abc"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.abc.com"

alert_preferencestring

Example: " phone"

status_poll_urlstring (url)

Example: "www.abc.com"

subscriber_details_requiredsubscriber_details_required (object)

subscriber_idboolean

Example: true

categoryboolean

Example: true

nameboolean

Example: true

phoneboolean

Example: true

emailboolean

Example: true

alert_urlboolean

Example: true

alert_preferenceboolean

Example: true

status_poll_urlboolean

Example: true

Response

success,message list

Body

subscriber_idstring

Example: "12345"

detailssubscriber_details (object)

namestring

Example: "abc"

categorystring

Example: "patient"

phonestring

Example: "+911234567890"

emailstring

Example: "abc@gmail.com"

alert_urlstring (url)

Example: "www.abc.com"

alert_preferencestring

Example: "phone"

status_poll_urlstring (url)

Example: "www.abc.com"

Request

Response

get list of events filetered by criteria in event_filter and return info specified by event_details_required with success or error code

GEThttp://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/list_details

Query parameters

requestor_id*string

Example: "healthngoadmin1"

request_token*string

Example: "Organizer"

qry*event_get_details_qry (object)

event_filterevent_filter (object)

event_idarray of string

Example: "[12345,51515]"

itemsstring

descriptionstring

Example: "medical camp for senior citizens"

namestring

Example: "doctor_consultation"

categorystring

Example: "opd_physician_consultation"

host_entity_idstring

Example: "67890"

subscriber_limitstring

Example: "1"

termsstring

Example: "non refundable"

fromstring (date-time)

Example: "2018-02-15T09:00:00"

tostring (date-time)

Example: "2018-02-15T17:00:00"

venuevenue (object)

buildingstring

Example: "xyz"

streetstring

Example: "7th main"

areastring

Example: "wilson garden"

citystring

Example: "bangalore"

statestring

Example: "karnataka"

countrystring

Example: "india"

latstring

Example: "0.001"

longstring

Example: "0.002"

event_details_requiredevent_details_required (object)

event_idboolean

Example: true

descriptionboolean

Example: true

nameboolean

Example: true

categoryboolean

Example: true

host_entity_idboolean

Example: true

periodboolean

Example: true

venueboolean

Example: true

deadlineboolean

Example: true

subscriber_limitboolean

Example: true

termsboolean

Example: true

statusboolean

Example: true

Response

success,event_list

Body

event_idstring

Example: "12345"

detailsevent_details (object)

namestring

Example: "abc medical camp"

descriptionstring

Example: "medical camp for senior citizens"

categorystring

Example: "doctor_consultation"

host_entity_idstring

Example: "67890"

fromstring (date-time)

Example: "2018-02-15T11:00:00"

tostring (date-time)

Example: "2018-02-15T11:30:00"

deadlinestring (date-time)

Example: "2018-02-15T11:10:00"

subscriber_limitstring

Example: "1"

termsstring

Example: "non refundable"

statusstring

Example: "open"

venuevenue (object)

buildingstring

Example: "xyz"

streetstring

Example: "7th main"

areastring

Example: "wilson garden"

citystring

Example: "bangalore"

statestring

Example: "karnataka"

countrystring

Example: "india"

latstring

Example: "0.001"

longstring

Example: "0.002"

Request

Response

[
  [
    {
      "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"
        }
      }
    }
  ]
]