HydraCore
API by router

Jobs shifts

List Jobs

GET
/internal/v1/instances/{instance_id}/jobs

Path Parameters

instance_idInstance Id
Formatuuid

Query Parameters

customer_idCustomer Id
Formatuuid
status?Status
site?Site
limit?Limit
Default100
Range1 <= value <= 500
offset?Offset
Default0
Range0 <= value

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/jobs?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=string&site=string&limit=100&offset=0"
{
  "has_more": true,
  "items": [
    null
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Job

Create a job. Auth: Bearer proxy key.

POST
/internal/v1/instances/{instance_id}/jobs

Path Parameters

instance_idInstance Id
Formatuuid

Request Body

client_name?Client Name
customer_idCustomer Id
Formatuuid
description?Description
job_ref?Job Ref
notes?Notes
requirements?Requirements
scheduled_date?Scheduled Date
site?Site
titleTitle
Lengthlength <= 500
work_type?Work Type

Response Body

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/jobs" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "title": "string"  }'
{
  "client_name": "string",
  "completed_date": "2019-08-24",
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job_ref": "string",
  "requirements": {},
  "scheduled_date": "2019-08-24",
  "site": "string",
  "status": "string",
  "title": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "work_type": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Job

PATCH
/internal/v1/instances/{instance_id}/jobs/{job_id}

Path Parameters

instance_idInstance Id
Formatuuid
job_idJob Id
Formatuuid

Request Body

client_name?Client Name
description?Description
notes?Notes
requirements?Requirements
site?Site
status?Status
title?Title
work_type?Work Type

Response Body

curl -X PATCH "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "client_name": "string",
  "completed_date": "2019-08-24",
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job_ref": "string",
  "requirements": {},
  "scheduled_date": "2019-08-24",
  "site": "string",
  "status": "string",
  "title": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "work_type": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Shifts

GET
/internal/v1/instances/{instance_id}/shifts

Path Parameters

instance_idInstance Id
Formatuuid

Query Parameters

customer_idCustomer Id
Formatuuid
status?Status
date_from?Date From
date_to?Date To
limit?Limit
Default100
Range1 <= value <= 500
offset?Offset
Default0
Range0 <= value

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/shifts?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=string&date_from=2019-08-24&date_to=2019-08-24&limit=100&offset=0"
{
  "has_more": true,
  "items": [
    null
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Shift

POST
/internal/v1/instances/{instance_id}/shifts

Path Parameters

instance_idInstance Id
Formatuuid

Request Body

customer_idCustomer Id
Formatuuid
dateDate
Formatdate
end_timeEnd Time
Formattime
headcount?Headcount
Default1
Range1 <= value
job_id?Job Id
rate_per_hour?Rate Per Hour
requirements?Requirements
site?Site
start_timeStart Time
Formattime

Response Body

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/shifts" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "date": "2019-08-24",    "end_time": "14:15:22Z",    "start_time": "14:15:22Z"  }'
{
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "date": "2019-08-24",
  "end_time": "14:15:22Z",
  "filled_count": 0,
  "headcount": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "is_filled": true,
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "rate_per_hour": 0,
  "requirements": {},
  "site": "string",
  "start_time": "14:15:22Z",
  "status": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Shift

Update shift details. Auth: Bearer proxy key.

PATCH
/internal/v1/instances/{instance_id}/shifts/{shift_id}

Path Parameters

instance_idInstance Id
Formatuuid
shift_idShift Id
Formatuuid

Request Body

date?Date
end_time?End Time
headcount?Headcount
rate_per_hour?Rate Per Hour
requirements?Requirements
site?Site
start_time?Start Time
status?Status

Response Body

curl -X PATCH "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/shifts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "date": "2019-08-24",
  "end_time": "14:15:22Z",
  "filled_count": 0,
  "headcount": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "is_filled": true,
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "rate_per_hour": 0,
  "requirements": {},
  "site": "string",
  "start_time": "14:15:22Z",
  "status": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Assign Person

POST
/internal/v1/instances/{instance_id}/shifts/{shift_id}/assign

Path Parameters

instance_idInstance Id
Formatuuid
shift_idShift Id
Formatuuid

Request Body

channel?Channel
person_idPerson Id
Formatuuid

Response Body

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/shifts/497f6eca-6276-4993-bfeb-53cbbbba6f08/assign" \  -H "Content-Type: application/json" \  -d '{    "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550"  }'
{
  "calendar_link_sent": true,
  "channel": "string",
  "contacted_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  "responded_at": "2019-08-24T14:15:22Z",
  "shift_id": "f15914ca-a3fc-41f9-a948-5ac849d2a017",
  "status": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Assignments

GET
/internal/v1/instances/{instance_id}/shifts/{shift_id}/assignments

Path Parameters

instance_idInstance Id
Formatuuid
shift_idShift Id
Formatuuid

Query Parameters

limit?Limit
Default100
Range1 <= value <= 500
offset?Offset
Default0
Range0 <= value

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/shifts/497f6eca-6276-4993-bfeb-53cbbbba6f08/assignments?limit=100&offset=0"
{
  "has_more": true,
  "items": [
    null
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Assignment

PATCH
/internal/v1/instances/{instance_id}/shifts/{shift_id}/assignments/{assignment_id}

Path Parameters

instance_idInstance Id
Formatuuid
shift_idShift Id
Formatuuid
assignment_idAssignment Id
Formatuuid

Request Body

calendar_link_sent?Calendar Link Sent
channel?Channel
status?Status

Response Body

curl -X PATCH "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/shifts/497f6eca-6276-4993-bfeb-53cbbbba6f08/assignments/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "calendar_link_sent": true,
  "channel": "string",
  "contacted_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  "responded_at": "2019-08-24T14:15:22Z",
  "shift_id": "f15914ca-a3fc-41f9-a948-5ac849d2a017",
  "status": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Jobs Dashboard

GET
/v1/customers/{customer_id}/jobs

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid

Query Parameters

status?Status
limit?Limit
Default100
Range1 <= value <= 500
offset?Offset
Default0
Range0 <= value

Response Body

curl -X GET "https://loading/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/jobs?status=string&limit=100&offset=0"
{
  "has_more": true,
  "items": [
    null
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Shifts Dashboard

GET
/v1/customers/{customer_id}/shifts

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid

Query Parameters

date_from?Date From
date_to?Date To
limit?Limit
Default100
Range1 <= value <= 500
offset?Offset
Default0
Range0 <= value

Response Body

curl -X GET "https://loading/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/shifts?date_from=2019-08-24&date_to=2019-08-24&limit=100&offset=0"
{
  "has_more": true,
  "items": [
    null
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Instances

Previous Page

Knowledge

Next Page