API / Resource
Use case / Master data sync

Create Resource Unavailabilities

Changed on

Create a new unavailability for a resource.

post/v1/resources/resource/{resource_id}/unavailability

Request

  • Base URL: https://api.qargo.com
  • URL: https://api.qargo.com/v1/resources/resource/{resource_id}/unavailability
  • Auth: OAuth 2 (client credentials, token URL /v1/auth/token)

Path parameters

resource_idstring uuid required

Request body

external_idstring nullable

External identifier of the unavailability

start_timestring date-time required

Start time of the unavailability

end_timestring date-time nullable

End time of the unavailability, leave empty for open interval

reason'DRIVER_FUNERAL' | 'DRIVER_HOLIDAY' | 'DRIVER_JOB_APPLICATION_LEAVE' | 'DRIVER_LATE_START_EARLY_LEAVE' | 'DRIVER_MEDICAL_EXAM' | 'DRIVER_OFF_SHIFT_PATTERN' | 'DRIVER_OTHER' | 'DRIVER_PARENTAL_LEAVE' | 'DRIVER_PUBLIC_HOLIDAY' | 'DRIVER_RECUP' | 'DRIVER_REDUCED_WORKING_HOURS_SCHEME' | 'DRIVER_SHIFT_PATTERN' | 'DRIVER_SICKNESS' | 'DRIVER_SOCIAL_LEAVE' | 'DRIVER_TEMPORARY_UNEMPLOYMENT' | 'DRIVER_TRAINING' | 'DRIVER_UNAUTHORISED_ABSENCE' | 'DRIVER_UNION_LEAVE' | 'DRIVER_WORK_ACCIDENT' | 'VEHICLE_BRAKE_TEST' | 'VEHICLE_CLEANING' | 'VEHICLE_FRC_CERTIFICATE' | 'VEHICLE_HIRE' | 'VEHICLE_HYDRAULIC_INSPECTION' | 'VEHICLE_INSPECTION' | 'VEHICLE_LIFT_OPS_EQUIP_REGULATIONS' | 'VEHICLE_MAINTENANCE' | 'VEHICLE_MOT_TEST' | 'VEHICLE_OFF_ROAD' | 'VEHICLE_OTHER' | 'VEHICLE_PRESSURE_TEST' | 'VEHICLE_REPAIR' | 'VEHICLE_SERVICE' | 'VEHICLE_TACHOGRAPH_CALIBRATION' | 'SUBCONTRACTOR_HOLIDAY' | 'SUBCONTRACTOR_SICKNESS' | 'SUBCONTRACTOR_OTHER' required
descriptionstring nullable

Response

Successful Response

external_idstring nullable

External identifier of the unavailability

start_timestring date-time required

Start time of the unavailability

end_timestring date-time nullable

End time of the unavailability, leave empty for open interval

reason'DRIVER_FUNERAL' | 'DRIVER_HOLIDAY' | 'DRIVER_JOB_APPLICATION_LEAVE' | 'DRIVER_LATE_START_EARLY_LEAVE' | 'DRIVER_MEDICAL_EXAM' | 'DRIVER_OFF_SHIFT_PATTERN' | 'DRIVER_OTHER' | 'DRIVER_PARENTAL_LEAVE' | 'DRIVER_PUBLIC_HOLIDAY' | 'DRIVER_RECUP' | 'DRIVER_REDUCED_WORKING_HOURS_SCHEME' | 'DRIVER_SHIFT_PATTERN' | 'DRIVER_SICKNESS' | 'DRIVER_SOCIAL_LEAVE' | 'DRIVER_TEMPORARY_UNEMPLOYMENT' | 'DRIVER_TRAINING' | 'DRIVER_UNAUTHORISED_ABSENCE' | 'DRIVER_UNION_LEAVE' | 'DRIVER_WORK_ACCIDENT' | 'VEHICLE_BRAKE_TEST' | 'VEHICLE_CLEANING' | 'VEHICLE_FRC_CERTIFICATE' | 'VEHICLE_HIRE' | 'VEHICLE_HYDRAULIC_INSPECTION' | 'VEHICLE_INSPECTION' | 'VEHICLE_LIFT_OPS_EQUIP_REGULATIONS' | 'VEHICLE_MAINTENANCE' | 'VEHICLE_MOT_TEST' | 'VEHICLE_OFF_ROAD' | 'VEHICLE_OTHER' | 'VEHICLE_PRESSURE_TEST' | 'VEHICLE_REPAIR' | 'VEHICLE_SERVICE' | 'VEHICLE_TACHOGRAPH_CALIBRATION' | 'SUBCONTRACTOR_HOLIDAY' | 'SUBCONTRACTOR_SICKNESS' | 'SUBCONTRACTOR_OTHER' required
descriptionstring nullable
idstring uuid required

Unique identifier of the unavailability

Changes

  • 6abdfcd1a541Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status