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

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

Response

success

Body

string

ID of created event

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"event_id:12345"

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

Response

success, event updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, event cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,event_list

Body

event_idstring

detailsevent_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//event/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

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

Response

success

Body

string

ID of created entity

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"entity_name:xyz hospital,entity_id:67890"

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

Response

success, entity updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, entity cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,entity list

Body

entity_idstring

detailsentity_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//entity/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  [
    {
      "entity_id": "67890",
      "details": {
        "category": "hospital",
        "name": "abc",
        "phone": "+911234567890",
        "email": "info@xyz.com",
        "website": "www.abc.com"
      }
    }
  ]
]

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

Response

success

Body

string

ID of created alert_schedule

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"alert_schedule_name:xyz hospital,alert_schedule_id:1"

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

Response

success, alert_schedule updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, alert_schedule cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,alert_schedule list

Body

alert_schedule_idstring

detailsalert_schedule_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//alert_schedule/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  [
    {
      "alert_schedule_id": "1",
      "details": {
        "event_id": "12345",
        "target_category": "subscriber",
        "message_id": "1",
        "alert_datetime": "2018-02-15T09:00:00"
      }
    }
  ]
]

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

Response

success

Body

string

ID of created message

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"message_name:xyz hospital,message_id:1"

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

Response

success, message updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, message cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,message list

Body

message_idstring

detailsmessage_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//message/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  [
    {
      "message_id": "1",
      "details": {
        "entity_id": "67890",
        "category": "reminder",
        "message_body": "you have doctor consultation today"
      }
    }
  ]
]

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

Response

success

Body

string

ID of created resource

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"resource_name:xyz hospital,resource_id:54321"

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

Response

success, resource updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, resource cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,resource list

Body

resource_idstring

detailsresource_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  [
    {
      "resource_id": "54321",
      "details": {
        "name": "psrk",
        "category": "doctor",
        "phone": "+911234567890",
        "email": "doctor1@xyz.com",
        "alert_url": "psrk@gmail.com",
        "alert_preference": "phone",
        "status_poll_url": "www.doctor1.com"
      }
    }
  ]
]

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

Response

success,resource list

Body

resource_idstring

resource_namestring

free_slotsarray of string

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//resource/availability', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

Response

success

Body

string

ID of created subscriber

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"subscriber_name:xyz hospital,subscriber_id:12345"

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

Response

success, subscriber updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, subscriber cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,message list

Body

subscriber_idstring

detailssubscriber_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//subscriber/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  [
    {
      "subscriber_id": "12345",
      "details": {
        "name": "abc",
        "category": "patient",
        "phone": "+911234567890",
        "email": "abc@gmail.com",
        "alert_url": "www.abc.com",
        "alert_preference": "phone",
        "status_poll_url": "www.abc.com"
      }
    }
  ]
]

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

Response

success

Body

string

ID of created affiliation

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"affiliation_name:xyz hospital,affiliation_id:1"

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

Response

success, affiliation updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, affiliation cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,affiliation list

Body

affiliation_idstring

detailsaffiliation_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//affiliation/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

Response

success

Body

string

ID of created appointment

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"[Event_id:12345,appointment_id:1]"

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

Response

success, appointment updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, appointment cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,appointment_list

Body

appointment_idstring

detailsappointment_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//appointment/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  [
    {
      "appointment_id": "1",
      "details": {
        "exclusive": "true",
        "event_id": "1",
        "participant_type": "subscriber",
        "participant_id": "12345",
        "status_id": "confirmed",
        "participant_entity_id": "67890"
      }
    }
  ]
]

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

Response

success

Body

string

ID of created log

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/new', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"log_name:xyz hospital,log_id:1"

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

Response

success, log updated

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/modifications', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

Response

success, log cancelled

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

success,log list

Body

log_idstring

detailslog_details (object)

Request

const response = await fetch('http://ss2.egovstack.net/r1/eGovStack/COM/11222456/SchedulerBB/creg//log/list_details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

4.10 Information Mediator Interface

This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.

4.11 PubSub Interface

This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.

4.12 Messaging interface

This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.

4.13 Scheduler Administration

This Services APIs is not yet specified, but it should be the purpose of a next iteration of the Scheduler Building Block Specification.

API standards

The microservice interfaces are defined as per OPENAPI Ver3.0 standards.
For implementation purposes, it is suggested to refer TMF630_REST_API_Design_Guidelines.

Last updated 5 months ago