HydraCore
API by router

Roster

Internal Start Cascade

POST
/internal/v1/instances/{instance_id}/roster/cascade

Path Parameters

instance_id*Instance Id
Formatuuid

Request Body

application/json
  1. body
shift_id*Shift Id
Formatuuid
tier?Tier
Range1 <= value <= 5
Default1

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/roster/cascade' \  -H 'Content-Type: application/json' \  -d '{  "shift_id": "f15914ca-a3fc-41f9-a948-5ac849d2a017"}'
Example Response
null

Internal Roster Respond

POST
/internal/v1/instances/{instance_id}/roster/respond

Path Parameters

instance_id*Instance Id
Formatuuid

Request Body

application/json
  1. body
channel?Channel
Lengthlength <= 30
Default"whatsapp"
person_id*Person Id
Formatuuid
response_text*Response Text
Length1 <= length <= 100

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/roster/respond' \  -H 'Content-Type: application/json' \  -d '{  "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",  "response_text": "string"}'
Example Response
null
GET
/internal/v1/instances/{instance_id}/roster/shift-status/{shift_id}

Path Parameters

instance_id*Instance Id
Formatuuid
shift_id*Shift Id
Formatuuid

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/roster/shift-status/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
null