API: Estado

M: Listar estados

HTTP GET:
https://<hostname>/api/vehicles/status
URL PARAMETERS:

Este método soporta el uso de filtros.

OUTPUT:

Json con los campos:

EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/vehicles/status
RESPUESTA:
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Maintenance",
      "color": "#FF5252",
      "vehicle_count": 20
    },
    {
      "id": 3,
      "name": "Being Repaired",
      "color": "#FF8E3B",
      "vehicle_count": 17
    },
    {
      "id": 4,
      "name": "Irregular use",
      "color": "#FFC107",
      "vehicle_count": 0
    },
    {
      "id": 0,
      "name": "Normal",
      "color": "#0069FF",
      "vehicle_count": 50
    },
    {
      "id": 2,
      "name": "Out of Service",
      "color": "#999999",
      "vehicle_count": 31
    }
  ]
}

M: Ver estado

HTTP GET:
https://<hostname>/api/vehicle/status/<id>
URL PARAMETERS:
Nombre Tipo Requerido Descripción
id Id del estado Numérico Id del estado que se quiere consultar.
OUTPUT:

Json con los campos:

EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/vehicle/status/0
RESPUESTA:
{
  "success": true,
  "data": {
    "id": "0",
    "name": "Normal",
    "color": "#0069FF"
  }
}

M: Actualizar estado

HTTP PUT:
https://<hostname>/api/vehicle/status/<id>
URL PARAMETERS:
Nombre Tipo Requerido Descripción
id Id del estado Numérico Id del estado que se quiere actualizar, no puede ser un default vehicle status.
BODY PARAMETERS:
OUTPUT:

Json con los campos:

EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X PUT
     --data "name=On%20Route"
     https://<hostname>/api/vehicle/status/1024
RESPUESTA:
{
  "success": true
}

M: Eliminar estado

HTTP DELETE:
https://<hostname>/api/vehicle/status/<id>
URL PARAMETERS:
Nombre Tipo Requerido Descripción
id Id del estado Numérico Id del estado que se quiere eliminar, no puede ser un default vehicle status.
OUTPUT:

Json con los campos:

EJEMPLO CON CURL:
$ curl -u <api_key>:<password>
     -X DELETE
     https://<hostname>/api/vehicle/status/1024
RESPUESTA:
{
  "success": true
}

O: Default Vehicle Status

Existen estados preexistentes los cuales son únicamente de lectura

id name color
0 Normal #0069FF
1 Mantenimiento #FF5252
2 Fuera de servicio #999999
3 En reparación #FF8E3B
4 Se usa de vez en cuando #FFC107

O: Vehicle Status Data Object

Cada objeto de estado tiene estos campos:

campo read-only requerido Descripción
id ID del estado: se genera automáticamente
vehicle_count Cantidad de vehículos que tienen asignado al estado
name si es un default vehicle status Nombre del estado
color si es un default vehicle status Color del estado