References¶

Retrieve Incidents¶

The GET incidents endpoint enables you to retrieve incident data

GET /v1/incidents

Note

Incidents are returned in descending order by the last updated date time in the response

Request¶

URL Parameters¶

Parameter	Type	Default Value	Description	Required
lastUpdatedFrom	DateTime	14 days before the current date time	Incident last updated date time in UTC (ISO 8601) for start of the date range (this is inclusive)	Yes - but only when lastUpdatedTo is provided
lastUpdatedTo	DateTime	The current date time	Incident last updated date time in UTC (ISO 8601) for end of date range (this is inclusive)	Yes - but only when lastUpdatedFrom is provided
pageNumber	Integer	0	Page number to retrieve. Page number cannot be less than 0.	No
pageSize	Integer	200	Number of incidents to return in a page. Page size must be between 0 and 500	No

Sample Request¶

GET /v1/incidents

GET /v1/incidents?lastUpdatedFrom=2024-05-01T00:00:00&lastUpdatedTo=2024-05-31T23:59:59&pageNumber=1&pageSize=500

Response¶

Field	Type	Description
incidents	Object Array	An array of incidents
incident.bookingReference	String	The booking reference
incident.incidentType	String	One of the following values: `DRIVER_LATENESS` `DRIVER_NO_SHOW` `CUSTOMER_NO_SHOW` `SERVICE_PROVIDED` `RIDEWAYS_SERVICE` `WRONG_VEHICLE` `DRIVER_SERVICE` `SUPPLIER_SERVICE` `DRIVER_DELAY_20_TO_40_MINS` `DRIVER_DELAY_UNDER_20_MINS` `DRIVER_DELAY_OVER_40_MINS` `INVESTIGATING_POST_JOURNEY_FEEDBACK` `OTHER`
incident.incidentStatus	String	One of the following values: `RESOLVED` `DISPUTED`
incident.responsibleParty	String	One of the following values: `CUSTOMER` `NO_ONE` `BOOKING.COM` `SUPPLIER`
incident.createdDateTimeUTC	DateTime	The timestamp when the incident was first created in UTC
incident.modifiedDateTimeUTC	DateTime	The timestamp when the incident was last modified in UTC
incident.pickupDateTimeUTC	DateTime	The timestamp of pickup in UTC
pageSize	Integer	The page size
currentPage	Integer	Current page number
hasNextPage	Boolean	Indicates if there are more incidents to return
nextHref	String	A link to retrieve the next page of incidents

HTTP 200 - OK¶

{
  "incidents": [
    {
      "bookingReference": "11523901",
      "incidentType": "DRIVER_NO_SHOW",
      "incidentStatus": "RESOLVED",
      "responsibleParty": "BOOKING.COM",
      "createdDateTimeUTC": "2024-08-05T14:18:50",
      "modifiedDateTimeUTC": "2024-08-05T14:18:50",
      "pickupDateTimeUTC": "2024-08-05T13:18:50"
    },
    {
      "bookingReference": "27191328",
      "incidentType": "CUSTOMER_NO_SHOW",
      "incidentStatus": "RESOLVED",
      "responsibleParty": "CUSTOMER",
      "createdDateTimeUTC": "2024-08-05T14:18:50",
      "modifiedDateTimeUTC": "2024-08-05T13:18:50",
      "pickupDateTimeUTC": "2024-08-05T10:18:50"
    }
  ],
  "pageSize": 200,
  "currentPage": 0,
  "hasNextPage": true,
  "nextHref": "/v1/incidents?lastUpdatedFrom=2024-07-22T15:18:50&lastUpdatedTo=2024-08-05T15:18:50&pageNumber=1&pageSize=200"
}

HTTP 400 - Bad Request¶

{
  "errorCode": "e152c59d-5327-433c-980b-12f759b6782e",
  "errorMessage": "Min.pageNumber: must be greater than or equal to 0"
}

Is this page helpful? Yes | No