Powered by Redocly

Outsourced tickets

Manage outsourced tickets.

Outsourced ticket

An outsourced ticket is a ticket for which you have requested a partnered provider to execute one or more products for you.

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.

outsource_provider_id
string <uuid>

Identifier of the provider of the outsource.

outsource_ticket_id
string <uuid>

Identifier of ticket at outsource provider.

reclaimable
boolean

Whether this ticket can be reclaimed. This is only possible if the outsource ticket is not yet in-progress.

voucher_code
string or null [ 4 .. 8 ] characters [A-Z0-9]

Voucher code.

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",
  • "outsource_provider_id": "bb1d5cca-3595-41db-afc4-9023f6904f93",
  • "outsource_ticket_id": "d751d57a-0733-4a09-874a-f41c0ff94e2f",
  • "reclaimable": true,
  • "voucher_code": "WQ4MM3",
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Retrieve 'Outsourced' tickets

Retrieve a list of 'Outsourced' 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 (Outsourced ticket) >= 0 items

List of 'Outsourced' 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.

outsource_provider_id
string <uuid>

Identifier of the provider of the outsource.

outsource_ticket_id
string <uuid>

Identifier of ticket at outsource provider.

reclaimable
boolean

Whether this ticket can be reclaimed. This is only possible if the outsource ticket is not yet in-progress.

voucher_code
string or null [ 4 .. 8 ] characters [A-Z0-9]

Voucher code.

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/outsourced-tickets
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve an outsourced ticket

Retrieve a single 'Outsourced' ticket by its identifier.

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

The identifier of the 'Outsourced' 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.

outsource_provider_id
string <uuid>

Identifier of the provider of the outsource.

outsource_ticket_id
string <uuid>

Identifier of ticket at outsource provider.

reclaimable
boolean

Whether this ticket can be reclaimed. This is only possible if the outsource ticket is not yet in-progress.

voucher_code
string or null [ 4 .. 8 ] characters [A-Z0-9]

Voucher code.

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/outsourced-tickets/{outsourced-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",
  • "outsource_provider_id": "bb1d5cca-3595-41db-afc4-9023f6904f93",
  • "outsource_ticket_id": "d751d57a-0733-4a09-874a-f41c0ff94e2f",
  • "reclaimable": true,
  • "voucher_code": "WQ4MM3",
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Transition outsourced ticket

Transition a single 'Outsourced' ticket by its identifier.

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

The identifier of the 'Outsourced' ticket.

Request Body schema: application/json

The changes you wish to make.

required
Reclaim (object)

Transition this ticket to a different state.

One of:

Reclaim an outsourced ticket. Reclaiming cancels the outsource-process and removes the outsourced ticket from the targeted outsource provider's dashboard. It can only be reclaimed if it's not yet picked up by an operator at the targeted outsource provider.

type
required
string

The type of transition to apply on this ticket.

Value Description
reclaim

Reclaim this ticket.

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

Forbidden.

default

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

patch/v2/tickets/outsourced-tickets/{outsourced-ticket-id}
Request samples
application/json
{
  • "transition": {
    }
}
Response samples
application/problem+json
{
  • "status": 403,
  • "type": "about:blank",
  • "title": "Forbidden",
  • "detail": "You are not authorized to access this resource."
}
➔ Next to Cancelled tickets