Jifeline Customer API (1.0.0)

Download OpenAPI specification:

This API offers a way to interact with Customer resources like retrieving connectors, selecting vehicles and creating tickets.

Connectors

Connectors are remote diagnose devices that can be plugged into the OBD port of a vehicle.

Websockets

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

Get the connectors

Get the connectors linked to the logged in user.

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] Example: limit=20 The maximum number of items to return, the maximum numers of items to return is set to 200.

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": 910329423,
"uuid": "5f3d760d-ade2-4a19-aea4-36e097678ae3",
"is_online": true,
"has_wifi": true,
"software_version": 2,
"hardware_version": 0,
"supports_doip": true,
"vehicle_path_string": "AUDI#100#100 - (44, 44Q, C3)#1.8 Quattro 65KW SH",
"vin_number": "VF1CN04054456164",
"product_description": "Tow Bar Coding (Aftermarket Equipment)",
"hardware_type": "classic"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Get a single connector

Get a single connector by providing a connector ID

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

connectorId

required

integer

ID of the connector

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"id": 910329423,
"uuid": "5f3d760d-ade2-4a19-aea4-36e097678ae3",
"is_online": true,
"has_wifi": true,
"software_version": 2,
"hardware_version": 0,
"supports_doip": true,
"vehicle_path_string": "AUDI#100#100 - (44, 44Q, C3)#1.8 Quattro 65KW SH",
"vin_number": "VF1CN04054456164",
"product_description": "Tow Bar Coding (Aftermarket Equipment)",
"hardware_type": "classic"
}

Get a single connector

Get a single connector by providing a connector UUID

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

connectorUUID

required

string <uuid>

UUID of the connector

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"id": 910329423,
"uuid": "5f3d760d-ade2-4a19-aea4-36e097678ae3",
"is_online": true,
"has_wifi": true,
"software_version": 2,
"hardware_version": 0,
"supports_doip": true,
"vehicle_path_string": "AUDI#100#100 - (44, 44Q, C3)#1.8 Quattro 65KW SH",
"vin_number": "VF1CN04054456164",
"product_description": "Tow Bar Coding (Aftermarket Equipment)",
"hardware_type": "classic"
}

Dismiss call for attention

Dismiss a call for attention on the connector

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

connectorUUID

required

string <uuid>

UUID of the connector

Responses

Response samples

400
401
404
500

Content type

application/json

{"status": 0,
"type": "string",
"title": "string",
"detail": "string"
}

Get the active ticket on a connector

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

connectorId

required

string

ID of the connector.

Responses

Response samples

200
400
401
404
500

Content type

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
}

Products

Products and product grouping

Get the Product groups

Product groups are the first layer in the hiarchy of grouping products.

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

vehicle_model_id required	integer Example: vehicle_model_id=332423 ID of the vehicle model to get product groups for
vehicle_model_variant_id required	integer Example: vehicle_model_variant_id=332423 ID of the vehicle model variant to get product groups for

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": 2691,
"name": "Multimedia, Infotainment Settings"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Get the Product bundles for a specific product group

Bundle of products that have a similar goal

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

product_group_id	number <int32> Example: product_group_id=2691 The ID of the product group.
vehicle_model_id required	integer Example: vehicle_model_id=332423 ID of the vehicle model to get product bundles for
vehicle_model_variant_id required	integer Example: vehicle_model_variant_id=332423 ID of the vehicle model variant to get product bundles for

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": "5f3d760d-ade2-4a19-aea4-36e097678ae3",
"product_group_id": 57182,
"name": "Navigation",
"description": "Navigation",
"reference": "01e2b527-c085-4d8a-ad02-715553d0becb",
"blocks": [{"optional": true,
"product_ids": [[52351,
52352
]
]
}
]
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Get Products

Products are services offered by service providers to execute on a selected vehicle.

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

vehicle_model_id required	integer Example: vehicle_model_id=332423 ID of the vehicle model to get products for
vehicle_model_variant_id required	integer Example: vehicle_model_variant_id=332423 ID of the vehicle model variant to get products for
product_group_id	number <int32> Example: product_group_id=2691 The ID of the product group. This parameter cannot be combined with product_bundle_id!
product_bundle_id	string <uuid> Example: product_bundle_id=e51c66a6-096b-412c-bd94-8c04ded544d5 The ID of the product bundle. This parameter cannot be combined with product_group_id!
	boolean or integer Default: true Return products with matching favorite flag

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": 52351,
"item_number": 100022,
"name": "Remote Diagnostic Support",
"internal_name": "Airbag Module Replacement",
"description": "Remote diagnostic support session. Have you met the conditions for submitting this diagnosis ticket? You can find more information on our website.",
"is_favorite": true,
"is_unattended": true,
"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"
},
"price": {"price_original": 10,
"price_final": 8,
"partner_price": 9,
"contains_discount": false,
"currency": "EUR"
}
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Add a product to the list of favorite products

By adding a product to the list of favorite products it is flagged as favorite and becomes available under the Favorites section of the customer portal.

Authorizations:

OAuth2JifelineAuthorizer

Request Body schema: application/json
required

The product to add to the list of favorite products.

id	integer A unique ID of the product
item_number	string A product's item number (SKU)
name	string The name of the product
internal_name	string Universal (internal, English) product name
description	string The description of the product
is_favorite	boolean Is product marked as favorite.
is_unattended	boolean Is product executed by an unattended process.
	object Gross price for this product
	object Nett price for this product
	object Total discount for this product
	object or null Original equipment service fee applicable for this product, null if none applies
	object Deprecated Product Price

Responses

Request samples

Payload

Content type

application/json

{"id": 52351,
"item_number": 100022,
"name": "Remote Diagnostic Support",
"internal_name": "Airbag Module Replacement",
"description": "Remote diagnostic support session. Have you met the conditions for submitting this diagnosis ticket? You can find more information on our website.",
"is_favorite": true,
"is_unattended": true,
"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"
},
"price": {"price_original": 10,
"price_final": 8,
"partner_price": 9,
"contains_discount": false,
"currency": "EUR"
}
}

Response samples

204

Content type

application/json

null

Remove product from the list of favorite products

By removing the product from the list of favorite products it is no longer flagged as favorite or available under the Favorites section of the customer portal.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

id

required

string

Product ID

Responses

Get product prerequisites, the prerequisites are selected based on the products and vehicle type

Get product prerequisites

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

vehicle_model_variant_id required	number <int32> Example: vehicle_model_variant_id=1480 Id of the vehicle model the product selected for.
vehicle_model_id required	integer Example: vehicle_model_id=332423 ID of the vehicle model to get products for
product_id required	Array of integers non-empty Example: product_id=100593,200593,300593 Product ID to get the prerequisites for.

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": 1,
"name": "Battery charger",
"description": "Check for battery",
"question": "Did you secure the vehicle's power supply?",
"required": true,
"type": "string",
"options": [{"id": 1,
"productPrerequisiteId": 1,
"value": "Left"
}
]
}
],
"total": 234,
"offset": 200,
"limit": 20
}

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

Authorizations:

None

path Parameters

ticketId

required

integer

Ticket identifier used to post CSAT score.

Responses

Add or update a Customer Satisfaction Score (CSAT) and optionally a comment for a ticket

Add or update a Customer Satisfaction Score (CSAT) and / or a comment for a ticket. The CSAT score should be between -1 and 1, where -1 is the lowest score and 1 is the highest score.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

ticketId

required

integer

Ticket identifier used to post CSAT score.

Request Body schema: application/json
required

The CSAT score

score required	number CSAT score
comment	string or null Comment for the CSAT score

Responses

Request samples

Payload

Content type

application/json

{"score": 1,
"comment": "Very friendly operator"
}

Response samples

204

Content type

application/json

null

Get available notes for a ticket.

Get available notes with attachments for a ticket.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

ticketId

required

integer

Ticket identifier used to retrieve notes.

Responses

Response samples

200
400
401
500

Content type

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
}

Get historical tickets for a given vehicle identification number

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

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

Responses

Response samples

200
400
401
500

Content type

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": "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"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Get historical ticket for a historical ticket id.

Get historical ticket for a given historical ticket id.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

historicalTicketId

required

integer

Historical ticket identifier used to retrieve notes.

Responses

Response samples

200
400
401
500

Content type

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"
}

Retrieve prepared tickets

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

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

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

Responses

Response samples

200
400
401
500

Content type

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": [{"product_id": 234234,
"name": "Remote diagnostics"
}
]
}
]
}

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.

Authorizations:

OAuth2JifelineAuthorizer

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

Request samples

Payload

Content type

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

201
400
401
500

Content type

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
}

Vehicles

Vehicle details

Retrieve recently serviced vehicles

Retrieve serviced vehicles, sorted by most recent to oldest.

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] Example: limit=20 The maximum number of items to return, the maximum numers of items to return is set to 200.

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"make_id": 10,
"make_name": "Ford",
"model_group_id": 44,
"model_group_name": "Focus",
"model_id": 23423,
"model_name": "FOCUS - II (DA_, HCP, DP)",
"model_variant_id": 34234,
"model_variant_name": "1.4 59KW ASDA, ASDB",
"vin": "JFL91010104391010",
"last_serviced_at": "2021-09-08T10:03:29+00:00"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Search for vehicle brand, model, type and engine by VIN

Get all vehicle brands

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

vin

required

string

Example: vin=JFL91010104391010

The Vehicle Identification number to search the vehicle for

Responses

Response samples

200
400
401
500

Content type

application/json

{"make": {"id": 10,
"name": "Ford"
},
"model_group": {"id": 234,
"name": "Focus",
"vehicle_make_id": 0,
"vehicle_make_name": "string"
},
"model": {"id": 23423,
"name": "FOCUS - II (DA_, HCP, DP) (2004 - 2013)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
},
"model_variant": {"id": 34234,
"name": "1.4 59KW ASDA, ASDB (2004 - 2012)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_id": 0,
"vehicle_model_name": "string",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}
}

Get vehicle makes

A vehicle make is the brand of the vehicle

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] Example: limit=20 The maximum number of items to return, the maximum numers of items to return is set to 200.

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": 10,
"name": "Ford"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Get a single vehicle make

A vehicle make is the brand of the vehicle

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

makeId

required

integer

Vehicle make ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": 10,
"name": "Ford"
}

Get vehicle model groups

Get vehicle model group for a make

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

vehicle_make_id required	number <int32> Example: vehicle_make_id=2691 The ID of the vehicle make.
offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] Example: limit=20 The maximum number of items to return, the maximum numers of items to return is set to 200.

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": 234,
"name": "Focus",
"vehicle_make_id": 0,
"vehicle_make_name": "string"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Get a single vehicle model-group

Get a single vehicle model-group (e.g. Laguna)

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

modelGroupId

required

integer

Vehicle model-group ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": 234,
"name": "Focus",
"vehicle_make_id": 0,
"vehicle_make_name": "string"
}

Get vehicle models

Get vehicle models for a model group

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

vehicle_model_group_id required	number <int32> Example: vehicle_model_group_id=2691 The ID of the vehicle model group.
offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] Example: limit=20 The maximum number of items to return, the maximum numers of items to return is set to 200.

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": 23423,
"name": "FOCUS - II (DA_, HCP, DP) (2004 - 2013)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Get a single vehicle model

Get a single vehicle model (e.g. Laguna III Grandtour)

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

modelId

required

integer

Vehicle model ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": 23423,
"name": "FOCUS - II (DA_, HCP, DP) (2004 - 2013)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}

Get vehicle model variants

Get vehicle model variants for a model

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

vehicle_model_id required	number <int32> Example: vehicle_model_id=2691 The ID of the vehicle model.
offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] Example: limit=20 The maximum number of items to return, the maximum numers of items to return is set to 200.

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": 34234,
"name": "1.4 59KW ASDA, ASDB (2004 - 2012)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_id": 0,
"vehicle_model_name": "string",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Get a single vehicle model-variant

Get a single vehicle model-variant (e.g. Laguna III Grandtour 2.0 16V Turbo 125KW F4R 811)

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

modelVariantId

required

integer

Vehicle model-variant ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": 34234,
"name": "1.4 59KW ASDA, ASDB (2004 - 2012)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_id": 0,
"vehicle_model_name": "string",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}

Cart

Shopping cart

Calculate prices for the given items

Authorizations:

OAuth2JifelineAuthorizer

Request Body schema: application/json
required

Products, vehicle and vouchercode to calculate totals for

voucher	string Voucher code for discount
vehicle_model_id required	integer The vehicle model id
vehicle_model_variant_id required	integer The vehicle model variant id
vin	string or null = 17 characters ^[a-zA-Z0-9]{17}$ VIN of the vehicle
prepared_ticket_id	string or null <uuid> The identifier of the prepared ticket
product_ids required	Array of integers products to calculate the prices for

Responses

Request samples

Payload

Content type

application/json

{"voucher": "234MD23",
"vehicle_model_id": 23423,
"vehicle_model_variant_id": 23423,
"vin": "JFL91010104591010",
"prepared_ticket_id": "ca09a970-6519-4280-b6a6-65727e2894e3",
"product_ids": [52351,
52352
]
}

Response samples

200
400
401
500

Content type

application/json

{"voucher": "23MDU53",
"voucher_discount": {"type": "percentual",
"percentage": 30.35,
"price": {"currency": "EUR",
"value": 100,
"localized_value": 110,
"localized_currency": "GBP"
}
},
"vehicle_model_id": 23423,
"vehicle_model_variant_id": 23423,
"needs_confirmation_for_unattended_service": true,
"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"
}
}
},
"voucher_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"
}
}
},
"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"
}
}
},
"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"
}
}
},
"items": [{"description": "string",
"product_id": 52351,
"product_item_number": 100022,
"product_name": "Remote Diagnostic Support",
"product_internal_name": "Airbag Module Replacement",
"product_description": "Remote diagnostic support session. Have you met the conditions for submitting this diagnosis ticket? You can find more information on our website.",
"product_is_unattended": true,
"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"
}
}
]
}

Users

User management

Get user information of the current logged-in user

Gets basic information of the users like, name, address, the user's company and the service provider the user is linked to.

Authorizations:

OAuth2JifelineAuthorizer

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": "0777bdfc-e9de-4a02-8958-46b3d36015ce",
"first_name": "John",
"middle_name": "Edeward",
"last_name": "Doe",
"client": {"name": "Garage John Doe",
"reference": "Garage john doe",
"allow_tickets_without_product": false,
"address": {"country": "NL",
"locality": "Zevenbergen",
"street": "main street 12a",
"postal_code": "7777 AZ"
}
},
"service_provider": {"id": 71,
"name": "Partner X",
"has_prepaid_wallet": true,
"prepaid_wallet_settings": {"balance": "120"
},
"payment_by_prepaid_balance": true,
"service_center": {"is_open": true,
"tickets_scheduler_active_until": "2021-09-08T10:03:29+00:00",
"tickets_scheduler_enabled": true,
"tickets_scheduler_message": "Ticket scheduling will be resumed tomorrow",
"service_message": "We are open for service",
"service_message_active": true
},
"currency": "EUR",
"ui": {"company_name": "Garage John Doe",
"portal_header_background_color": "#fff",
"portal_headerlogo_path": "/media/cache/service_provider_portal_header_logo_thumb/",
"theme_color": "#00aeef"
},
"help_center_url": "https://help-center-jifeline.com",
"privacy_policy_url": "https://www.partner-privacy-policy.com",
"remote_access_url": "https://www.remote-access.com",
"terms_of_service_url": "https://www.terms-of-service.com"
}
}

Employees

Employee management

Get list of employees

Get a list of employees.

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] Example: limit=20 The maximum number of items to return, the maximum numers of items to return is set to 200.

Responses

Response samples

200
400
401
500

Content type

application/json

{"total": 234,
"offset": 200,
"limit": 20,
"result": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"given_name": "John",
"family_name": "Smith",
"username": "john.smith@my-garage.com",
"enabled": true,
"correspondence_locale": "en-GB"
}
]
}

Add employee

Add a new employee.

Authorizations:

OAuth2JifelineAuthorizer

Request Body schema: application/json
required

Employee to create

given_name required	string <= 255 characters Given name of employee.
family_name required	string <= 255 characters Family name of employee.
username required	string or null <email> [ 1 .. 255 ] characters Username of employee. Once set it cannot be unset, only updated.
correspondence_locale	string <bcp47> Locale used when sending correspondence to this employee. Only supported system locales are allowed.

Responses

Request samples

Payload

Content type

application/json

{"given_name": "John",
"family_name": "Smith",
"username": "john.smith@my-garage.com",
"correspondence_locale": "en-GB"
}

Response samples

201
400
401
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"given_name": "John",
"family_name": "Smith",
"username": "john.smith@my-garage.com",
"enabled": true,
"correspondence_locale": "en-GB"
}

Get employee

Gets basic information of the employee like first-, family- and username. Using "me" as the employeeId will return this information for the currently logged-in employee.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

required

string or string

Employee identifier.

Responses

Response samples

200
400
401
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"given_name": "John",
"family_name": "Smith",
"username": "john.smith@my-garage.com",
"enabled": true,
"correspondence_locale": "en-GB"
}

Change employee

Change a new employee.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

required

string or string

Employee identifier.

Request Body schema: application/json
required

Properties to change.

given_name required	string <= 255 characters Given name of employee.
family_name required	string <= 255 characters Family name of employee.
username required	string or null <email> [ 1 .. 255 ] characters Username of employee. Once set it cannot be unset, only updated.
correspondence_locale	string <bcp47> Locale used when sending correspondence to this employee. Only supported system locales are allowed.

Responses

Request samples

Payload

Content type

application/json

{"given_name": "John",
"family_name": "Smith",
"username": "john.smith@my-garage.com",
"correspondence_locale": "en-GB",
"enabled": null
}

Response samples

200
400
401
500

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"given_name": "John",
"family_name": "Smith",
"username": "john.smith@my-garage.com",
"enabled": true,
"correspondence_locale": "en-GB"
}

Chats

Authentication

Send forgot password mail

This endpoint is required for the migration phase of the customer portal and is only intended to be used for the Jifeline Customer Portal.

Authorizations:

None

Request Body schema: application/json
required

Forgot password body containing e-mail address

email_address

required

string

email address used to reset password fore

Responses

Request samples

Payload

Content type

application/json

{"email_address": "test@test.nl"
}

Response samples

200
400
401
500

Content type

application/json

{"method": "SESSION"
}

Login using connector ID and connector pincode Deprecated

Login using connector ID and connector pincode, response includes the ID token, access token and refresh token. This API endpoint is deprecated. Please use the connector UUID to log in.

Authorizations:

None

Request Body schema: application/json
required

Login using connector ID and pincode

connector_id	string ID of the connector to login for
pincode	string Pincode of the connector

Responses

Request samples

Payload

Content type

application/json

{"connector_id": 940201044,
"pincode": 1234
}

Response samples

200
400
401
500

Content type

application/json

{"id_token": "eyJraW2In0.eyJhdF9....",
"access_token": "eyJraW2In0.eyJhdF9....",
"refresh_token": "eyJraW2In0.eyJhdF9...."
}

Login using connector UUID and connector pincode

Login using connector UUID and connector pincode, response includes the ID token, Access token and Refresh token

Authorizations:

None

Request Body schema: application/json
required

Login using connector UUID and pincode

connector_uuid	string UUID of the connector to login for
pincode	string Pincode of the connector

Responses

Request samples

Payload

Content type

application/json

{"connector_uuid": "6ec2911c-a09a-11ee-8c90-0242ac120002",
"pincode": 1234
}

Response samples

200
400
401
500

Content type

application/json

{"id_token": "eyJraW2In0.eyJhdF9....",
"access_token": "eyJraW2In0.eyJhdF9....",
"refresh_token": "eyJraW2In0.eyJhdF9...."
}

Login using an OTP

Login using an OTP, response includes the ID token, Access token and Refresh token

Authorizations:

None

Request Body schema: application/json
required

Login using connector UUID and pincode

otp	string OTP

Responses

Request samples

Payload

Content type

application/json

{"otp": "bafd50b7-7388-4eb1-8812-cbb5517faa2c"
}

Response samples

200
400
401
500

Content type

application/json

{"id_token": "eyJraW2In0.eyJhdF9....",
"access_token": "eyJraW2In0.eyJhdF9....",
"refresh_token": "eyJraW2In0.eyJhdF9...."
}

Customer

Customer self management

Retrieve customer wallet

Retrieve the prepaid wallet for the customer. It provides the current balance and details on its state.

Authorizations:

OAuth2JifelineAuthorizer

Responses

Response samples

200
400
401
500

Content type

application/json

{"balance": 150,
"balance_state": "healthy"
}

Get customer information of the currently logged-in user

Get customer details of a currently logged-in user

Authorizations:

OAuth2JifelineAuthorizer

Responses

Response samples

200
400
401
500

Content type

application/json

{"name": "Autodiagnose Vogels",
"reference": 213432,
"street": "Zevensprong",
"number": "7",
"postal_code": "6511AA",
"city": "Amsterdam",
"country": "NL",
"email_address": "john@forbes.com",
"financial_email_address": "patricia@blackrock.com",
"phone": 31651226913,
"currency": "EUR"
}

Edit a authenticated user's customer details

Edit authenticated user's customer details

Authorizations:

OAuth2JifelineAuthorizer

Request Body schema: application/json
required

Company details

name	string Company name
street	string Company street name
number	string Company street number
postal_code	string Company postal code
city	string Company city
country	string Company country code
email_address	string Company e-mail address
financial_email_address	string Company financial dpt. e-mail address
phone	string Company phone number

Responses

Request samples

Payload

Content type

application/json

{"name": "Autodiagnose Vogels",
"street": "Zevensprong",
"number": "7",
"postal_code": "6511AA",
"city": "Amsterdam",
"country": "NL",
"email_address": "john@forbes.com",
"financial_email_address": "patricia@blackrock.com",
"phone": 31651226913
}

Response samples

200
400
401
500

Content type

application/json

{"name": "Autodiagnose Vogels",
"reference": 213432,
"street": "Zevensprong",
"number": "7",
"postal_code": "6511AA",
"city": "Amsterdam",
"country": "NL",
"email_address": "john@forbes.com",
"financial_email_address": "patricia@blackrock.com",
"phone": 31651226913,
"currency": "EUR"
}

Get branding information of the currently logged-in user

Get branding details of a currently logged-in user

Authorizations:

OAuth2JifelineAuthorizer

Responses

Response samples

200
400
401
500

Content type

application/json

{"branding_name": "Autodiagnose Vogels",
"customer_portal_url": "customer-portal.obd.help"
}

Service center

Get service center

Gets service center information for the current logged-in user.

Authorizations:

OAuth2JifelineAuthorizer

Responses

Response samples

200
400
401
500

Content type

application/json

{"name": "Automotive diagnostics",
"payment_by_prepaid_wallet": true,
"pricing_version": 1,
"primary_background_color": "#000000",
"logo": "/file/path/header_logo.png",
"service_message": "We are closed on Friday May 5th because of a national holiday. Automated services are still available.",
"primary_color": "#000000",
"help_center_url": "https://help-center.url",
"privacy_policy_url": "https://privacy-policy.url",
"remote_access_url": "https://remote-access.url",
"terms_of_service_url": "https://terms-of-service.url",
"sales_access_url": "https://sales-access.url",
"csat_enabled": true
}

Retrieve service center status

Retrieve information regarding the state of the service-center. Mainly it's acceptance of new tickets and their possible scheduling.

Authorizations:

OAuth2JifelineAuthorizer

Responses

Response samples

200
400
401
500

Content type

application/json

{"state": "opened",
"ends_at": "2023-05-22T12:44:36+0200",
"message": "We are experiencing high demand of our service, please wait."
}

System

Shared system resources.

Retrieve countries

Retrieve configureable countries for customers.

Authorizations:

OAuth2JifelineAuthorizer

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"id": "NL",
"code": "NL",
"name": "The Netherlands"
}
]
}

Retrieve currencies

Retrieve configureable currencies for customers.

Authorizations:

OAuth2JifelineAuthorizer

Responses

Response samples

200
400
401
500

Content type

application/json

{"result": [{"code": "EUR",
"name": "Euro",
"symbol": "€",
"is_custom": false
}
]
}

CSAT

Options

Enable CORS by returning correct headers

Authorizations:

None

path Parameters

ticketId

required

integer

Ticket identifier used to post CSAT score.

Responses

Add or update a Customer Satisfaction Score (CSAT) and optionally a comment for a ticket

Add or update a Customer Satisfaction Score (CSAT) and / or a comment for a ticket. The CSAT score should be between -1 and 1, where -1 is the lowest score and 1 is the highest score.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

ticketId

required

integer

Ticket identifier used to post CSAT score.

Request Body schema: application/json
required

The CSAT score

score required	number CSAT score
comment	string or null Comment for the CSAT score

Responses

Request samples

Payload

Content type

application/json

{"score": 1,
"comment": "Very friendly operator"
}

Response samples

204

Content type

application/json

null

Messenger

Get channel

Get channel by channel id.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

channelId

required

string

Channel identifier used to retrieve channel.

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"arn": "string",
"state": "string"
}

Translate text

Translate text by providing text and target language.

Authorizations:

OAuth2JifelineAuthorizer

Request Body schema: application/json
required

Messages to translate

required	object Message with the original text and the translated text.
target_language required	string Target language of the translation.

Responses

Request samples

Payload

Content type

application/json

{"message": {"original": "Hello world!"
},
"target_language": "de"
}

Response samples

201
400
401
500

Content type

application/json

{"message": {"original": "Hello world!",
"translated": "Hallo Welt!"
},
"target_language": "de",
"source_language": "en"
}

Send control message

Sending a control message which will trigger a ping over the websockets.

Authorizations:

OAuth2JifelineAuthorizer

path Parameters

channelId

required

string

Channel identifier used to retrieve channel.

Responses

Response samples

200
400
401
500

Content type

application/json

{"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459"
}

create channel attachment

Create channel attachment for a channel. Presigned url in response can be used to upload attachment.

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

channel_id

required

string

Channel identifier used to retrieve attachments.

Request Body schema: application/json
required

Create channel attachment

file_name

string

Filename of the attachment.

Responses

Request samples

Payload

Content type

application/json

{"file_name": "file.txt"
}

Response samples

201
400
401
500

Content type

application/json

{"file_name": "file.txt",
"signed_url": "http://example.com",
"file_reference": "/channel/abcb2f39-7620-401a-8dab-ec2f6075ed8a/abcb2f39-7620-401a-8dab-ec2f6075ed8a/file.txt"
}

get channel attachments

Get attachments for a channel.

Authorizations:

OAuth2JifelineAuthorizer

query Parameters

channel_id required	string Channel identifier used to retrieve attachments.
file_reference required	string File refrence used to retrieve attachments. This is returned in response of create channel attachment. Or can be found in message in a chat.

Responses

Response samples

200
400
401
500

Content type

application/json

{"file_name": "file.txt",
"signed_url": "http://example.com",
"file_reference": "/channel/abcb2f39-7620-401a-8dab-ec2f6075ed8a/abcb2f39-7620-401a-8dab-ec2f6075ed8a/file.txt"
}

Jifeline Customer API (1.0.0)

Connectors

Get the connectors

Authorizations:

query Parameters

Responses

Response samples

Get a single connector

Authorizations:

path Parameters

Responses

Response samples

Get a single connector

Authorizations:

path Parameters

Responses

Response samples

Dismiss call for attention

Authorizations:

path Parameters

Responses

Response samples

Get the active ticket on a connector

Authorizations:

path Parameters

Responses

Response samples

Products

Get the Product groups

Authorizations:

query Parameters

Responses

Response samples

Get the Product bundles for a specific product group

Authorizations:

query Parameters

Responses

Response samples

Get Products

Authorizations:

query Parameters

Responses

Response samples

Add a product to the list of favorite products

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove product from the list of favorite products

Authorizations:

path Parameters

Responses

Get product prerequisites, the prerequisites are selected based on the products and vehicle type

Authorizations:

query Parameters

Responses

Response samples

Tickets

Options

Authorizations:

path Parameters

Responses

Add or update a Customer Satisfaction Score (CSAT) and optionally a comment for a ticket

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get available notes for a ticket.

Authorizations:

path Parameters

Responses

Response samples

Get historical tickets for a given vehicle identification number

Authorizations:

query Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required