API / Resource
Use case / Master data sync
Get Resource Validity
Fetches a specific validity for a resource
get/v1/resources/resource/{resource_id}/validity/{id}
Path parameters
resource_idstring uuid required
idstring uuid required
Response
Successful Response
start_timestring date-time required
Start time of the validity
end_timestring date-time nullable
End time of the validity from a planning perspective
legal_end_timestring date-time nullable
End time of the validity from a legal perspective
generate_unavailabilityboolean
Generate a planning unavailability once the validity end time has passed
type'EUROVIGNET' | 'FUEL_CARD' | 'FINE' | 'CONTAINER_CERTIFICATE' | 'CONTAINER_DAMAGE_REPORT' | 'CONTAINER_INSPECTION_REPORT' | 'CONTAINER_LEASE' | 'CONTAINER_MAINTENANCE_REPORT' | 'CONTAINER_REPAIR_REPORT' | 'CONTAINER_TANK_TEST_CERTIFICATE_2Y5' | 'CONTAINER_TANK_TEST_CERTIFICATE_5Y' | 'CONTAINER_TANK_TEST_CERTIFICATE' | 'DRIVER_ADR_EXTRA_TRAINING' | 'DRIVER_ADR_LICENSE' | 'DRIVER_AEO_REGULATED_AGENT_LICENSE' | 'DRIVER_CARD' | 'DRIVER_CIVIL_LIABILITY_EXPLOITATION' | 'DRIVER_CIVIL_LIABILITY_INSURANCE' | 'DRIVER_CODE_95' | 'DRIVER_DRIVING_LICENSE' | 'DRIVER_IDENTITY_CARD' | 'DRIVER_IMI_PORTAL' | 'DRIVER_INSURANCE' | 'DRIVER_MEDICAL_EXAM' | 'DRIVER_PERSONAL_PROTECTIVE_EQUIPMENT' | 'DRIVER_RECUP' | 'DRIVER_REFUGEE_TRAINING_LICENSE' | 'DRIVER_SHIFT_PATTERN' | 'DRIVER_SICK_NOTE' | 'DRIVER_TRAINING' | 'BBS_CERTIFICATE' | 'FORKLIFT_LICENSE' | 'PAYSCALE_DRIVER' | 'VCA_BASIC_SAFETY' | 'TOLL_CARD' | 'SAFETY_CERTIFICATE_TERMINAL' | 'EXCEPTIONAL_TRANSPORT_LICENSE' | 'A1_DOCUMENT' | 'DRIVER_CPC_CARD' | 'DRIVER_POSTING_DOCUMENT' | 'SITE_MOVEMENT_SHEET' | 'DRIVER_PARENTAL_LEAVE' | 'DRIVER_JOB_APPLICATION_LEAVE' | 'DRIVER_PUBLIC_HOLIDAY' | 'DRIVER_SOCIAL_LEAVE' | 'DRIVER_UNION_LEAVE' | 'DRIVER_LONG_HEAVY_VEHICLE_CERT' | 'DRIVER_CARGOCARD_ACCESS_CARD' | 'DRIVER_ALFAPASS' | 'DRIVER_OFF_SHIFT_PATTERN' | 'DRIVER_REDUCED_WORKING_HOURS_SCHEME' | 'DRIVER_UNAUTHORISED_ABSENCE' | 'VEHICLE_MOT_TEST' | 'VEHICLE_REGISTRATION' | 'VEHICLE_INSURANCE_CERTIFICATE' | 'VEHICLE_TRANSPORT_LICENSE' | 'VEHICLE_DAMAGE_REPORT' | 'VEHICLE_MAINTENANCE_REPORT' | 'VEHICLE_ADR_CERTIFICATE' | 'VEHICLE_REPAIR_REPORT' | 'VEHICLE_TACHO' | 'VEHICLE_TIR' | 'VEHICLE_PHOTO' | 'VEHICLE_12_WEEKLY_CHECK' | 'VEHICLE_FIRE_EXTINGUISHER_SERVICE' | 'VEHICLE_UK_HGV_LEVY' | 'VEHICLE_ATP_CERTIFICATE' | 'VEHICLE_FRIDGE_MOTOR' | 'OVERSIZE_WL_PERMIT' | 'ROADTAX' | 'CERTIFICATE_OF_CONFORMITY' | 'BRAKE_TEST_CERTIFICATE' | 'BREAK_TEST_CERTIFICATE' | 'VEHICLE_IDENTIFICATION_REPORT' | 'VEHICLE_FRC_CERTIFICATE' | 'VEHICLE_GERMAN_SECURITY_INSPECTION' | 'VEHICLE_GERMAN_VEHICLE_INSPECTION' | 'CITERNE_CLEANING_CERTIFICATE' | 'HEAVY_LOAD_BE' | 'HEAVY_LOAD_DE' | 'HEAVY_LOAD_FR' | 'XL_CERTIFICATE' | 'VEHICLE_SERVICE' | 'VEHICLE_HIRE' | 'VEHICLE_BRAKE_TEST' | 'VEHICLE_HYDRAULIC_INSPECTION' | 'VEHICLE_LIFT_OPS_EQUIP_REGULATIONS' | 'VEHICLE_PRESSURE_TEST' | 'VEHICLE_TACHOGRAPH_CALIBRATION' required
external_idstring nullable
ID of the validity in the external master data system
descriptionstring nullable
idstring uuid required
Unique identifier of the validity
Changes
No recorded changes to this endpoint across all 1 revision of this API.