Push Deleted trip

Introduction

There are use cases where the DriveKit SDK allows the user to delete a trip.

The request to delete a trip results in the permanent deletion of all trip data from DriveKit's local database and DriveQuant's database.

If the trip data has been posted to your backend as well (via the push data service,), it should be deleted accordingly.

In order to perform this, a push deleted trip service can be configured.

Principle

The push deleted trip sends the event information when the user deletes the trip via a push service.

Configuration

Trip deletion event is sent as a POST request to a client URL. The URL must be provided to DriveQuant in order to set up and activate the push update trip service.

The body of the request is a JSON object with a set of fields that contain the id of the trip, and the trip modification event.

It is mandatory to configure a response code. If the post is accepted, we expect a status code of 200 (OK). In case of failure, for any answer other than 200, the service will attempt to post the data again. The retry strategy is described below.

If the service returns a 200 HTTP code while the data has not been accepted by the client server, then, there will be no further attempt to send the data.

Security

The security configuration must be identical to thatof the push data service.

Automatic Retry

DriveQuant will retry to push the deleted trip data in case of a HTTP error. In order to avoid too many consecutive retries, the push deleted trips replay will be performed one time per day from the day after a fail, this until the trip deletion has been accepted. If after 30 days the trip deletion has not been accepted, the replay will not be performed anymore.

REST request

POSThttps://my-api.example.com/push/trip/event

Header parameters

Body

application/json

itinId*string

Trip unique identifier

event*enum

Trip update event

TRIP_DELETION

date*string (date-time)

Date when trip event occurs

Response

200401

Event successfully processed

Request

JavaScriptCurl

const response = await fetch('https://my-api.example.com/push/trip/event', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "itinId": "text",
      "event": "TRIP_DELETION",
      "date": "2023-02-08T10:00:00.000+0200"
    }),
});
const data = await response.json();