Powered by Redocly

Cancelled tickets

Manage cancelled tickets.

Cancelled ticket

A 'Cancelled' ticket is a ticket that has been cancelled and is not currently being worked on.

id
string <uuid>

Ticket identifier.

created_at
string <date-time>

Date and time of creation.

customer_id
string <uuid>

Identifier of the customer for whom the ticket was created.

ticket_number
integer <int64>

Human-readable ticket identifier.

vehicle_model_id
integer <int64>

Identifier of the vehicle model on the ticket.

vin
string = 17 characters

Vehicle Identification Number (VIN) of the vehicle on the ticket.

finished_at
string <date-time>

Date and time service stopped on this ticket.

cancel_reason_id
integer <int32>

Reference to a cancel reason.

externally_processed
boolean

Whether this ticket has been processed by an external system. This field is purely present to allow an external system to easily register if it has already "processed" it. This property value is never changed from within the Jifeline system.

operator_id
string or null <uuid>

Identifier of the assigned operator. When a ticket has been automatically cancelled this value is empty.

external_reference
string <= 255 characters

Reference of this ticket to something in an external system. This property value is never changed from within the Jifeline system.

vehicle_battery_voltage
string

Detected vehicle battery voltage system 12 volt or 24 volt.

Enum Value Description
12v

12V battery system.

24v

24V battery system.

connection_id
string or null <uuid>

Identifier of the connection.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "ticket_number": 7440303,
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "cancel_reason_id": 0,
  • "externally_processed": true,
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "external_reference": "string",
  • "vehicle_battery_voltage": "12v",
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Retrieve 'Cancelled' tickets

Retrieve a list of 'Cancelled' tickets.

SecurityOAuth2
Request
query Parameters
external_reference
string

Filter tickets by external reference.

externally_processed
boolean

Only return tickets that are or are not processed by an external system.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

ticket_number
number <int64>

Filter tickets by ticket number.

Example: ticket_number=7179072
vehicle_battery_voltage
string

Filter tickets by vehicle battery voltage system.

Enum Value Description
12v

12V battery system.

24v

24V battery system.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Cancelled ticket) >= 0 items

List of 'Cancelled' tickets.

Array (>= 0 items)
id
string <uuid>

Ticket identifier.

created_at
string <date-time>

Date and time of creation.

customer_id
string <uuid>

Identifier of the customer for whom the ticket was created.

ticket_number
integer <int64>

Human-readable ticket identifier.

vehicle_model_id
integer <int64>

Identifier of the vehicle model on the ticket.

vin
string = 17 characters

Vehicle Identification Number (VIN) of the vehicle on the ticket.

finished_at
string <date-time>

Date and time service stopped on this ticket.

cancel_reason_id
integer <int32>

Reference to a cancel reason.

externally_processed
boolean

Whether this ticket has been processed by an external system. This field is purely present to allow an external system to easily register if it has already "processed" it. This property value is never changed from within the Jifeline system.

operator_id
string or null <uuid>

Identifier of the assigned operator. When a ticket has been automatically cancelled this value is empty.

external_reference
string <= 255 characters

Reference of this ticket to something in an external system. This property value is never changed from within the Jifeline system.

vehicle_battery_voltage
string

Detected vehicle battery voltage system 12 volt or 24 volt.

Enum Value Description
12v

12V battery system.

24v

24V battery system.

connection_id
string or null <uuid>

Identifier of the connection.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/cancelled-tickets
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve a cancelled ticket

Retrieve a single 'Cancelled' ticket by its identifier.

SecurityOAuth2
Request
path Parameters
cancelled-ticket-id
required
string <uuid>

The identifier of the 'Cancelled' ticket.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Ticket identifier.

created_at
string <date-time>

Date and time of creation.

customer_id
string <uuid>

Identifier of the customer for whom the ticket was created.

ticket_number
integer <int64>

Human-readable ticket identifier.

vehicle_model_id
integer <int64>

Identifier of the vehicle model on the ticket.

vin
string = 17 characters

Vehicle Identification Number (VIN) of the vehicle on the ticket.

finished_at
string <date-time>

Date and time service stopped on this ticket.

cancel_reason_id
integer <int32>

Reference to a cancel reason.

externally_processed
boolean

Whether this ticket has been processed by an external system. This field is purely present to allow an external system to easily register if it has already "processed" it. This property value is never changed from within the Jifeline system.

operator_id
string or null <uuid>

Identifier of the assigned operator. When a ticket has been automatically cancelled this value is empty.

external_reference
string <= 255 characters

Reference of this ticket to something in an external system. This property value is never changed from within the Jifeline system.

vehicle_battery_voltage
string

Detected vehicle battery voltage system 12 volt or 24 volt.

Enum Value Description
12v

12V battery system.

24v

24V battery system.

connection_id
string or null <uuid>

Identifier of the connection.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/cancelled-tickets/{cancelled-ticket-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "ticket_number": 7440303,
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "cancel_reason_id": 0,
  • "externally_processed": true,
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "external_reference": "string",
  • "vehicle_battery_voltage": "12v",
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Update a cancelled ticket

Update a single cancelled ticket by its identifier.

SecurityOAuth2
Request
path Parameters
cancelled-ticket-id
required
string <uuid>

The identifier of the 'Cancelled' ticket.

Request Body schema: application/json
required

The cancelled ticket you wish to update.

externally_processed
required
boolean

Whether this ticket has been processed by an external system. This field is purely present to allow an external system to easily register if it has already "processed" it. This property value is never changed from within the Jifeline system.

external_reference
required
string <= 255 characters

Reference of this ticket to something in an external system. This property value is never changed from within the Jifeline system.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Ticket identifier.

created_at
string <date-time>

Date and time of creation.

customer_id
string <uuid>

Identifier of the customer for whom the ticket was created.

ticket_number
integer <int64>

Human-readable ticket identifier.

vehicle_model_id
integer <int64>

Identifier of the vehicle model on the ticket.

vin
string = 17 characters

Vehicle Identification Number (VIN) of the vehicle on the ticket.

finished_at
string <date-time>

Date and time service stopped on this ticket.

cancel_reason_id
integer <int32>

Reference to a cancel reason.

externally_processed
boolean

Whether this ticket has been processed by an external system. This field is purely present to allow an external system to easily register if it has already "processed" it. This property value is never changed from within the Jifeline system.

operator_id
string or null <uuid>

Identifier of the assigned operator. When a ticket has been automatically cancelled this value is empty.

external_reference
string <= 255 characters

Reference of this ticket to something in an external system. This property value is never changed from within the Jifeline system.

vehicle_battery_voltage
string

Detected vehicle battery voltage system 12 volt or 24 volt.

Enum Value Description
12v

12V battery system.

24v

24V battery system.

connection_id
string or null <uuid>

Identifier of the connection.

default

An error occurred - see status code and problem response for more information.

put/v2/tickets/cancelled-tickets/{cancelled-ticket-id}
Request samples
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "externally_processed": true,
  • "external_reference": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "ticket_number": 7440303,
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "cancel_reason_id": 0,
  • "externally_processed": true,
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "external_reference": "string",
  • "vehicle_battery_voltage": "12v",
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Transition cancelled ticket

Transition a single 'Cancelled' ticket by its identifier.

SecurityOAuth2
Request
path Parameters
cancelled-ticket-id
required
string <uuid>

The identifier of the 'Cancelled' ticket.

Request Body schema: application/json

The changes you wish to make.

required
Complete (object)

Transition this ticket to a different state.

One of:

Complete a ticket, meaning it was successfully finished. If it is currently cancelled, this transition is only possible when its cancel reason allows reopening, when it is not externally processed or it is not already part of the providers' periodic invoice.

type
required
string

The type of transition to apply on this ticket.

Value Description
complete

Complete this ticket.

Responses
303

Transitioned.

Response Headers
Location
string <uri-reference>

Path to resource the ticket has been transitioned to.

Example: "/v2/tickets/closed-tickets/f2c4cf2d-c633-466b-b161-c01ab5bf66f0"
400

Bad request.

default

An error occurred - see status code and problem response for more information.

patch/v2/tickets/cancelled-tickets/{cancelled-ticket-id}
Request samples
application/json
{
  • "transition": {
    }
}
Response samples
application/problem+json
{
  • "status": 400,
  • "type": "about:blank",
  • "title": "Some title for the error situation",
  • "detail": "Some description for the error situation"
}
➔ Next to Closed tickets