Tickets

Tickets are the orders of products in the Customer portal.

Websockets

This service is used for status updates on connectors, connections and tickets. More information about the websockets can be found here.

Options

Enable CORS by returning correct headers

SecurityNone

Request

path Parameters

ticketId

required

integer

Ticket identifier used to retrieve notes.

Responses

200

Enable CORS by returning correct headers

options/v1/tickets/{ticketId}/notes

Get available notes for a ticket.

Get available notes with attachments for a ticket.

SecurityOAuth2 or JifelineAuthorizer

Request

path Parameters

ticketId

required

integer

Ticket identifier used to retrieve notes.

Responses

200

Successfully retrieved notes for a ticket.

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

500

Returned when an error occurs on the server

get/v1/tickets/{ticketId}/notes

Response samples

application/json

{"result": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ticket_id": 0,
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"attachments": [{"filename": "file.txt",
"signed_url": "http://example.com"
}
]
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone

Request

path Parameters

channelId

required

string

Channel identifier used to retrieve channel.

Responses

200

Enable CORS by returning correct headers

options/v1/channels/{channelId}

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/translate

Options

Enable CORS by returning correct headers

SecurityNone

Request

query Parameters

channel_id

required

string

Channel identifier used to retrieve attachments.

Responses

200

Enable CORS by returning correct headers

options/v1/channel-attachments

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/historical-tickets

Get historical tickets for a given vehicle identification number

SecurityOAuth2 or JifelineAuthorizer

Request

query Parameters

vin	string Vehicle identification number Example: vin=JFL91010104491010
connector_id	integer The ID of the used connector Example: connector_id=910101043

Responses

200

Succesfully fetched historical tickets

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

500

Returned when an error occurs on the server

get/v1/historical-tickets

Response samples

application/json

{"result": [{"id": 7014044,
"connector_id": 910101043,
"state": 7,
"vin": "JFL91010104591010",
"odometer_reading": 138853,
"reference": "Licence plate",
"voucher": "23MDU53",
"vehicle_model_id": 23423,
"vehicle_model_variant_id": 23423,
"sub_total": {"gross_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"net_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"total_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
}
},
"total": {"gross_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"net_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"total_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
}
},
"original_equipment_service_fee": {"gross_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"net_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"total_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
}
},
"product_lines": [{"product_id": 1234,
"description": "Tow bar coding",
"quantity": 2,
"gross_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"net_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"total_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
},
"original_equipment_service_fee": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"discounts": [{"product_id": 1234,
"description": "Tow bar coding",
"discount": {"type": null,
"percentage": null,
"price": { }
}
}
]
}
],
"created_at": "2021-09-08T10:03:29+00:00",
"finished_at": "2021-09-08T10:03:29+00:00"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone

Request

path Parameters

historicalTicketId

required

integer

Historical ticket identifier used to retrieve notes.

Responses

200

Enable CORS by returning correct headers

options/v1/historical-tickets/{historicalTicketId}

Get historical ticket for a historical ticket id.

Get historical ticket for a given historical ticket id.

SecurityOAuth2 or JifelineAuthorizer

Request

path Parameters

historicalTicketId

required

integer

Historical ticket identifier used to retrieve notes.

Responses

200

Succesfully fetched historical tickets

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

500

Returned when an error occurs on the server

get/v1/historical-tickets/{historicalTicketId}

Response samples

application/json

{"id": 7014044,
"connector_id": 910101043,
"state": 7,
"vin": "JFL91010104591010",
"odometer_reading": 138853,
"reference": "Licence plate",
"voucher": "23MDU53",
"vehicle_model_id": 23423,
"vehicle_model_variant_id": 23423,
"sub_total": {"gross_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"net_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"total_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
}
},
"total": {"gross_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"net_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"total_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
}
},
"original_equipment_service_fee": {"gross_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"net_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"total_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
}
},
"product_lines": [{"product_id": 1234,
"description": "Tow bar coding",
"quantity": 2,
"gross_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"net_price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"total_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
},
"original_equipment_service_fee": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
},
"discounts": [{"product_id": 1234,
"description": "Tow bar coding",
"discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
}
}
]
}
],
"created_at": "2021-09-08T10:03:29+00:00",
"finished_at": "2021-09-08T10:03:29+00:00"
}

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/prepared-tickets

Retrieve prepared tickets

Retrieve available prepared tickets for the authenticated customer and/or vehicle (via VIN).

SecurityOAuth2 or JifelineAuthorizer

Request

query Parameters

offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] The maximum number of items to return, the maximum numers of items to return is set to 200. Example: limit=20
vin required	string Filter prepared tickets and return those available for a vehicle with provided VIN. Example: vin=JFL91010104491010

Responses

200

Prepared tickets

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

500

Returned when an error occurs on the server

get/v1/prepared-tickets

Response samples

application/json

{"total": 234,
"offset": 200,
"limit": 20,
"result": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"vin": "JFL91010104591010",
"vehicle_model_id": 32443,
"vehicle_model_variant_id": 0,
"product_lines": [[ ]
]
}
]
}

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/tickets

Create a new ticket

Creates a new ticket containing one or more products for a specific vehicle with VIN It is not possible to create a ticket on a connector when there is a pending ticket on the connector.

SecurityOAuth2 or JifelineAuthorizer

Request

Request Body schema: application/json
required

Creates a ticket

vin required	string The Vehicle Identification number the ticket is created for
vehicle_model_id required	integer The ID of the vehicle model
vehicle_model_variant_id required	integer The ID of the vehicle model variant
connector_id required	integer The ID of the connected connector
voucher	string Voucher code for discount
product_ids required	Array of integers Array of products ids that will be purchased in the ticket
	Array of objects (Answer to a product prerequisite) Ticket attributes are answers on the product prerequisite of the products in the ticket
required	object Metadata for the ticket
prepared_ticket_id	string or null <uuid> The identifier of the prepared ticket
reference	string Default: "" Reference of the ticket
confirmed_unattended_service	boolean Default: false true if confirmation for auto-outsourcing to an unattended service is given.

Responses

201

Created

400

Returned when a client sends a bad request.

401

Returned when a request is performed without or with an incorrect OIDC token

500

Returned when an error occurs on the server

post/v1/tickets

Request samples

Payload

application/json

{"vin": "JFL91010104391010",
"vehicle_model_id": "284841",
"vehicle_model_variant_id": "284841",
"connector_id": 910101043,
"voucher": "234MD23",
"product_ids": [52351,
52352
],
"product_prerequisites": [{"definition_id": 1,
"value": "true"
}
],
"metadata": {"app_name": "Web Client",
"app_version": "1.16.6",
"platform": "Mac OS",
"platform_version": "10.15.6",
"device_manufacturer": "Apple",
"device_model": "Chrome 92.0.4515.159",
"battery_state": "67",
"locale": "nl_NL",
"latitude": "51.985104",
"longitude": "5.898730",
"vin_is_found_by_reader": true
},
"prepared_ticket_id": "ca09a970-6519-4280-b6a6-65727e2894e3",
"reference": "aa-bb-12",
"confirmed_unattended_service": true
}

Response samples

application/json

{"id": "3",
"uuid": "abcb2f39-7620-401a-8dab-ec2f6075ed8a",
"vin": "JFL91010104591010",
"vinNumber": "JFL91010104591010",
"vehicle_model_id": 23423,
"vehicle_model_variant_id": 23423,
"product_ids": [[324234
]
],
"chat_id": "2349283_416e4c77-4fc0-40ca-b5a5-95a12c4e84e8",
"connector_id": 990001234,
"state": 1
}

➔ Next to Vehicles

Tickets

Options

path Parameters

Get available notes for a ticket.

path Parameters

Options

path Parameters

Options

Options

query Parameters

Options

Get historical tickets for a given vehicle identification number

query Parameters

Options

path Parameters

Get historical ticket for a historical ticket id.

path Parameters

Options

Retrieve prepared tickets

query Parameters

Options

Create a new ticket

Request Body schema: application/jsonrequired

Request Body schema: application/json
required