Pending tickets

Manage pending tickets.

Pending ticket

A pending ticket is a ticket that is ready to be serviced by an operator.

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.
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",
"connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Retrieve pending tickets

Retrieve a list of pending tickets.

SecurityOAuth2

Request

query Parameters

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

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 (Pending ticket) >= 0 items

List of pending 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.
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/pending-tickets

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0
},
"result": [{"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",
"connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}
],
"total": 3255
}

Retrieve a pending ticket

Retrieve a single pending ticket by its identifier.

SecurityOAuth2

Request

path Parameters

pending-ticket-id

required

string <uuid>

The identifier of the pending 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.
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/pending-tickets/{pending-ticket-id}

Response samples

200
default

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",
"connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Transition pending ticket

Transition a single pending ticket by its identifier.

SecurityOAuth2

Request

path Parameters

pending-ticket-id

required

string <uuid>

The identifier of the pending ticket.

Request Body schema: application/json

The changes you wish to make.

required

Start service (object)

Transition this ticket to a different state.

One of:

The given operator will be assigned to this ticket and it will be marked as being 'In Progress' in the ticket workspace.

type

required

string

The type of transition to apply on this ticket.

Value	Description
start-service	Start service on this ticket.

operator_id

required

string <uuid>

Identifier of a provider employee who is able to service a ticket (has 'true' for is_operator property).

Responses

303

Transitioned.

Response Headers
Location	string <uri-reference> Path to resource the ticket has been transitioned to. Example: "/v2/tickets/in-progress-tickets/f2c4cf2d-c633-466b-b161-c01ab5bf66f0"

default

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

patch/v2/tickets/pending-tickets/{pending-ticket-id}

Request samples

Payload

application/json

{"transition": {"type": "start-service",
"operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166"
}
}

Response samples

default

application/problem+json

Returned when the request cannot be handled due to something that is perceived to be a client error.

{"detail": "The request violates one or more constraints. Please resolve all of them and try again.",
"status": 400,
"title": "Bad request",
"type": "/problems/violations",
"violations": [{"property_path": "gross_price.amount",
"in": "body",
"detail": "Value must be greater than 0"
},
{"property_path": "provider_id",
"in": "query",
"detail": "Provider with ID 3445 does not exist."
}
]
}

➔ Next to In progress tickets