-
Notifications
You must be signed in to change notification settings - Fork 1
Incident Events
Martyn Whitwell edited this page Feb 9, 2021
·
7 revisions
This page documents events that can be created about incidents that might happen during a move in the Book A Secure Move API.
Indicates a breakdown event and the exact postcode of the event. If the postcode is not available, the location_description must be provided. If a change of vehicle was necessary, please indicate the
new/old vehicle registrations using the JourneyChangeVehicle event.
Use the notes to indicate the reason for the breakdown.
Please use the common occurred_at attribute to indicate the closest date time to when the incident was expected to have occurred.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
postcode- The exact postcode where the incident occurred, if available -
location_description- A freetext description of the location, required if the postcode cannot be provided -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:28 +0000",
"recorded_at": "2020-12-03 10:51:28 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"a7e17509-b2db-400c-a7f3-e94f77ffc60c"
],
"vehicle_reg": "WQZ-8452",
"reported_at": "2020-12-03T10:51:28+00:00",
"postcode": "W1A 1AA",
"location_description": "Portland Place, London"
},
"event_type": "PersonMoveVehicleBrokeDown"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "9061b929-d56e-4372-8937-d1684f340478"
}
},
"location": {
"data": {
"id": "a3cb9c21-caaa-4cbe-8d31-48bf1bfa6c6a",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
vehicle_reg- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
postcode- must be a valid UK postcode -
location_description- presence - unless the postcode is provided -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
This event indicates a system failure in the vehicle. If the postcode is not available, the location_description must be provided. It may or may not lead to a breakdown and/or change of vehicle event.
Use the notes attribute to give more detail about the systems failure.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
postcode- The exact postcode where the incident occurred, if available -
location_description- A freetext description of the location, required if the postcode cannot be provided -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:28 +0000",
"recorded_at": "2020-12-03 10:51:28 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"b7188e10-78ae-4b75-b2b9-affd28e9cf27"
],
"vehicle_reg": "DUB-7704",
"reported_at": "2020-12-03T10:51:28+00:00",
"postcode": "W1A 1AA",
"location_description": "Portland Place, London"
},
"event_type": "PersonMoveVehicleSystemsFailed"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "4a3568d7-7e64-4cc6-9a2e-dbac714a1087"
}
},
"location": {
"data": {
"id": "6736b9f5-07e7-46e4-9605-9203d752213f",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
vehicle_reg- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
postcode- must be a valid UK postcode -
location_description- presence - unless the postcode is provided -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
Person Escaped - KPI breach
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:28 +0000",
"recorded_at": "2020-12-03 10:51:28 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"8452e09d-9f1b-4311-8cb2-8cf93d191ff4"
],
"vehicle_reg": "BUG-1858",
"reported_at": "2020-12-03T10:51:28+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMovePersonEscapedKpi"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "4b81addb-61e1-4201-aca9-ba57af540ff8"
}
},
"location": {
"data": {
"id": "09c37f1d-092e-45ae-a04b-f4aab07edc58",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
vehicle_reg- optional, required if escape was from the supplier vehicle -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
Person Escaped - no KPI breach
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:29 +0000",
"recorded_at": "2020-12-03 10:51:29 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"759e2bf8-f72c-4907-9855-473baf0d32ca"
],
"vehicle_reg": "UUP-8247",
"reported_at": "2020-12-03T10:51:29+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMovePersonEscaped"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "04cf03e0-0081-40e0-8b62-fe3f8e0194e8"
}
},
"location": {
"data": {
"id": "499bb3e0-a546-4174-a19d-7689abba9aae",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
vehicle_reg- optional, required if escape was from the supplier vehicle -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
Person was released and moved due to an error.
Please use the notes attribute to indicate the reason for the error.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:28 +0000",
"recorded_at": "2020-12-03 10:51:28 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"2d4735e0-d70a-42c4-b340-3c109ca3fecd"
],
"vehicle_reg": "EIQ-2306",
"reported_at": "2020-12-03T10:51:28+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMoveReleasedError"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "a35a3c9b-0dbc-4d36-9071-133290a23eab"
}
},
"location": {
"data": {
"id": "71d699d9-4d9d-4a3c-ad8e-8b37b3f5467d",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
Person had force used against them during a move.
Please use the notes attribute to indicate the details of the force used.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:30 +0000",
"recorded_at": "2020-12-03 10:51:30 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"7fd8eb5a-ebc6-44d5-870c-78147e601b7e"
],
"vehicle_reg": "QOL-6642",
"reported_at": "2020-12-03T10:51:30+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMoveUsedForce"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "6776b08c-3fd3-4c98-bd58-5b8a0a57d677"
}
},
"location": {
"data": {
"id": "c76616c4-2310-45ae-9d74-89329b194009",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
vehicle_reg- optional, required if force was applied in a supplier vehicle -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
Person assaulted supplier staff at some point during a move.
Please use the notes attribute to indicate the details of the assault.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:30 +0000",
"recorded_at": "2020-12-03 10:51:30 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"fb31b6a5-dd79-46c5-983f-e7e36223f902"
],
"vehicle_reg": "QMS-5386",
"reported_at": "2020-12-03T10:51:30+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMoveAssault"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "5c626cf9-2d53-4f4b-859e-9cbbcf2fe298"
}
},
"location": {
"data": {
"id": "9342c4c1-58bf-4e26-a5f8-4db6d10e258c",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
vehicle_reg- optional, required if assault was in the supplier vehicle -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
Event that indicates that the person died in the custody of the supplier.
Please use the notes attribute to indicate any additional information that is relevant.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:30 +0000",
"recorded_at": "2020-12-03 10:51:30 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"38cb3c77-7b6b-401b-9e74-fc6c9fb2b582"
],
"vehicle_reg": "HTS-1712",
"reported_at": "2020-12-03T10:51:30+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMoveDeathInCustody"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "384a7e10-9b73-4b7f-a243-ada35a6657ce"
}
},
"location": {
"data": {
"id": "824c6dfe-d5d6-4ae8-9c40-3df05bad4be6",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
vehicle_reg- optional, required if death was in the supplier vehicle -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
Person was seriously injured at some point during a move.
Please use the notes attribute to indicate any additional information that is relevant.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:29 +0000",
"recorded_at": "2020-12-03 10:51:29 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"d0fdbcd1-195e-4074-a274-99b61c9737ab"
],
"vehicle_reg": "SVW-6234",
"reported_at": "2020-12-03T10:51:29+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMoveSeriousInjury"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "a4591b7a-1008-41c9-8599-656c7e131f87"
}
},
"location": {
"data": {
"id": "8ab34558-da4f-4511-8e31-947d74599a1c",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
vehicle_reg- optional, required if serious injury occurred in the supplier vehicle -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
An major incident not captured by the PersonMoveAssault, PersonMoveSeriousInjury or PersonMoveDeathInCustody events.
Please use the notes attribute to indicate as much information as possible.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:30 +0000",
"recorded_at": "2020-12-03 10:51:30 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"54c4ea37-c3f3-46bc-ab10-14a372f5f412"
],
"vehicle_reg": "QHM-2639",
"reported_at": "2020-12-03T10:51:30+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMoveMajorIncidentOther"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "63da3c96-3f7f-4e7a-a93f-a486fc002cde"
}
},
"location": {
"data": {
"id": "a91e016b-a4fb-4a5f-affc-e70e19ea0374",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
vehicle_reg- optional, required if major incident occurred in the supplier vehicle -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
An incident the supplier personnel deemed as minor but note worthy.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:28 +0000",
"recorded_at": "2020-12-03 10:51:28 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"3e64ca89-5803-4798-9157-7e5e7487f15b"
],
"vehicle_reg": "EIN-5822",
"reported_at": "2020-12-03T10:51:28+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMoveMinorIncidentOther"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "d81cb751-bc9a-4752-9f05-043087d13d64"
}
},
"location": {
"data": {
"id": "7199b17b-46bb-4442-92fa-80c9f65b802b",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
vehicle_reg- optional, required if incident occurred in the supplier vehicle -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
Road traffic accident occurred interrupting the move process.
Please use the notes attribute to indicate as much information as possible.
-
supplier_personnel_numbers- A list of supplier personnel indicators that were involved with the incident -
vehicle_reg- The registration of the vehicle -
reported_at- The date time the incident was reported -
location- The location the incident occurred or the destination the vehicle was headed -
fault_classification- Indicates who is at fault for this incident.
POST /api/events
{
"data": {
"type": "events",
"attributes": {
"occurred_at": "2020-12-03 10:51:27 +0000",
"recorded_at": "2020-12-03 10:51:27 +0000",
"notes": "Additional information about this event",
"details": {
"supplier_personnel_numbers": [
"cfffbd1c-3d24-48bc-a00c-5c38a306ba04"
],
"vehicle_reg": "THI-8370",
"reported_at": "2020-12-03T10:51:27+00:00",
"fault_classification": "investigation"
},
"event_type": "PersonMoveRoadTrafficAccident"
},
"relationships": {
"eventable": {
"data": {
"type": "moves",
"id": "621cfd9b-9092-4441-954c-8bff80b80f4a"
}
},
"location": {
"data": {
"id": "f7e60102-c98e-489a-a0e3-5e6976c59f27",
"type": "locations"
}
}
}
}
}-
supplier_personnel_numbers- presence -
vehicle_reg- presence -
reported_at- presence, iso8601 date -
location- presence, is an existing location identifier -
fault_classification- presence, one of 'was_not_supplier', 'supplier', or 'investigation'
None
- API Guide
- Version 2
- Asked Questions
- Webhook & Email notifications
- Walkthroughs
- Deployment
- Useful Queries
- Data quality improvements
-
Journeys and Payment Related Calls
- Single journey move
- Redirection before move commences
- Redirection after move commences
- Lockouts and Lodgings
- Assessments
- Event Documentation
- GPS Track a move