Booking List

GET /booking/list

This API is to get bookings. This is an authendicated API so we need to pass bearer token in request header to access the data.

Headers

  • Accept string Required

    application/json

  • Content-Type string Required

    application/json

Query parameters

  • start_date string Required

    The planned day to get report from

  • end_date string Required

    The planned day to get report till

  • region number

    Id of region to filter booking

  • business_unit number

    Id of business unit to filter booking

  • shift string

    Shift name to filter booking

    Values are Day or Night.

  • candidate string

    Id of candidate to filter booking

  • jobs string

    Array of job ids to filter booking

  • status boolean

    pass 0 for Unpublished and 1 for published

  • deleted boolean

    pass 1 to get deleted bookings

    Default value is 0.

  • delete_type boolean

    pass 0 to deleted only shift or 1 to Deleted and moved to open shift

  • per_page number

    Minimum value is 1 and maximum value is 100

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • status string
    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • current_page integer
      • data array[object]
        Hide data attributes Show data attributes object
        • candidate_name string
        • business_unit_name string
        • business_unit_email string
        • bookings_email string
        • client_id integer
        • client_name string
        • candidate_email string
        • id number
        • code string
        • vacancy_id number
        • candidate_id number
        • status string
        • notes string
        • vacancy_note string
        • is_publish boolean
        • is_deleted boolean
        • is_confirm boolean
        • reason_to_delete string
        • created_by string
        • break string
        • job_title string
        • job_color string
        • booked_by string
        • deleted_by string
        • is_moved_to_vacancies boolean
        • start_time string
        • end_time string
        • on_date string
        • deleted_at string
        • created_at string
        • total_hours string
        • vacancy_created_at string
      • first_page_url string
      • from integer
      • last_page integer
      • last_page_url string
      • next_page_url string
      • path string
      • per_page integer
      • prev_page_url string
      • to integer
      • total integer
    • message string
GET /booking/list 
curl \
 --request GET 'https://api-console.logezy.co/v1/booking/list?start_date=string&end_date=string' \
 --header "Accept: Bearer your-access-token" \
 --header "Content-Type: application/json"
Response examples (200) 
{
  "data": {
    "to": 5,
    "data": [
      {
        "id": 2185,
        "code": "BKIN2185",
        "break": 60,
        "notes": null,
        "status": "pending",
        "on_date": "12-12-2022",
        "end_time": "08:00 PM",
        "booked_by": "Khushali",
        "client_id": 207,
        "job_color": "#0EB995",
        "job_title": "Nurse",
        "created_at": "14-12-2022 07:18 AM",
        "created_by": 4186,
        "deleted_at": null,
        "deleted_by": null,
        "is_confirm": 0,
        "is_deleted": 0,
        "is_publish": 1,
        "start_time": "08:00 AM",
        "vacancy_id": 3133,
        "client_name": "24 Care",
        "total_hours": "11.00",
        "candidate_id": 120,
        "region_names": "London,Glasgow",
        "vacancy_note": null,
        "bookings_email": null,
        "candidate_name": "Abey K",
        "candidate_email": "[email protected]",
        "reason_to_delete": null,
        "business_unit_name": "24 Care Unit 1",
        "vacancy_created_at": "14-12-2022 06:42 PM",
        "business_unit_email": "[email protected]",
        "is_moved_to_vacancies": 0
      }
    ],
    "from": 1,
    "path": "http://api-console.localhost:8000/v1/booking/list",
    "total": 5,
    "per_page": "10",
    "last_page": 1,
    "current_page": 1,
    "last_page_url": "http://api-console.localhost:8000/v1/booking/list?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "http://api-console.localhost:8000/v1/booking/list?page=1"
  },
  "status": "success",
  "message": "Bookings retrieved successfully."
}