Módulo Tickets
- Pedro Doroshenko
- Santiago Nanclares (Unlicensed)
A continuación se describen los métodos de la API de la plataforma Octopus referentes al módulo de Tickets, los cuales permiten por ejemplo obtener todos los tickets emitidos o generar uno nuevo.
Servicios
GET - Get Services of Location
Devuelve los diferentes métodos de validación o servicios definidos en las Localizaciones indicado mediante el parámetro LocationId.
https://<server-domainname>/rest/<version>/Location/{LocationId}/services |
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI |
|
GET | LocationId | Identificador de la Localización | String | SI |
|
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
{
"data": [
{
"id": 59219,
"LocationId": "28XXX004",
"typeId": "ttf",
"name": "Ticket - 1 Hora",
"price": 0,
"status": 1,
"onlineTime": 0,
"expTime": 3600,
"tpv": 0,
"pms": 0,
"showLogin": 1,
"simDevices": 10,
"maxUsers": 1,
"loginMethod": "general",
"download": 0,
"upload": 0,
"downrate": 0,
"uprate": 0,
"dailyLimit": 0,
"validUntil": 15552000,
"vip": 0,
"validateEmail": 0,
"deleted": 0,
"withRegistration": 0,
"macCaching": 0,
"issueOrder": 0,
"type": {
"id": "ttf",
"description": "Tiempo corrido",
"timetofinish": true,
"onlinetime": false,
"timetolimit": false,
"limittraffic": false
}
}
],
"pagination": {
"offset": 0,
"limit": 5000,
"rows": 9,
"pages": 1,
"currentPage": 1
}
}
|
401 | Unauthorized |
|
El identificador o ID de cada servicio se deberá enviar como parámetro para crear Tickets, tal y como se detalla en el siguiente método. |
Tickets
POST - Create a Ticket
Crea un ticket para la Localización indicada mediante el parámetro LocationId. Se debe indicar además el servicio sobre el que se quiere crear el Ticket, el cual se puede obtener usando el método descrito anteriormente. El resto de parámetros dependen del tipo de servicio seleccionado, el cual se debe de indicar mediante el parámetro service.
https://<server-domainname>/rest/<version>/Location/{LocationId}/tickets |
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI |
|
GET | LocationId | Identificador de la Localización | String | SI |
|
POST | start_time |
| date (ISO-8601) |
| Fecha actual |
POST | valid_until |
| date (ISO-8601) |
| Fecha actual |
POST | format |
| String (print, email) |
|
|
POST | service | Identificador del servicio | String(16) | SI |
|
POST | userId | Identificador del usuario | String(64) |
|
|
POST | numusers | Número de usuarios simultaneos | integer |
|
|
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
a
GET - Get Tickets of Location
Devuelve todos los tickets que hayan sido emitidos en la Localizacion indicado mediante el parámetro LocationId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationId | Identificador de la Localización | String | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |