Obtener Datos GPS

1. Obtener Datos GPS

https://apibambas.gpsgoldcar.com/api/avls/tracks/	VALUE	REQUIRED (GET)	EXAMPLE
Headers (Key):
Authorization	Token token_proporcionado	*	Token 34bfe2a7da9e96b833ae3ea7c7c171d119eeadbe

Headers

• El Header será obligatorio para consumir el EP ya que si no se cuenta con ello, retornará error.
• El EP está restringido a un máximo de 8 horas hacia atrás, esto debido a la cantidad de datos que se retornan en caso el EP no sea consumido en un tiempo considerable.

Estructura del Diccionario

• "timestamp" -> Datetime, formato (YY-MM-DD hh:mm:ss)
• "latitude" -> Float
• "longitude" -> Float
• "speed" -> Integer
• "avl" -> String, CharField (tamaño máximo = 7)
• "curso" -> Integer, valores posibles (de 0 a 360).
• "altitud" -> Integer
• "ign" -> Integer, valores posibles (motor apagado = 0, motor encendido = 1)

1.1 Correcto

SUCESSFUL

Status Code: 200 OK

• Si el token fue el correcto, la petición devolverá la data ordenada de manera decreciente con respecto al timestamp. Del más reciente al más antiguo.

[
    {
        "timestamp": "2023-01-23 09:52:54",
        "latitude": -14.798375000,
        "longitude": -71.415105000,
        "speed": 0,
        "avl": "BLU-879",
        "curso": 319,
        "altitud": 2616,
        "ign": 0
    },
    {
        "timestamp": "2023-01-23 09:51:38",
        "latitude": -15.984666667,
        "longitude": -71.219733333,
        "speed": 0,
        "avl": "BNA-725",
        "curso": 245,
        "altitud": 2096,
        "ign": 0
    },
]

1.2 Incorrecto (Token Inválido)

ERROR

Status Code: 400 Bad Request

{
    "detail": "Invalid token."
}

1.3 Incorrecto (No Token)

ERROR

Status Code: 401 Unauthorized

• Si el token no es enviado, el EP retornará un error.

{
    "detail": "Authentication credentials were not provided."
}

2. Obtener Datos GPS Por Filtro

https://apibambas.gpsgoldcar.com/api/avls/tracksfilter/	VALUE	REQUIRED (GET)	EXAMPLE
Headers (Key):
Authorization	Token token_proporcionado	*	Token 34bfe2a7da9e96b833ae3ea7c7c171d119eeadbe

Params	---	---	---
KEY	VALUE	REQUIRED	EXAMPLE
start_time	DateTime	*	2023-02-10 11:58:00
end_time	DateTime	*	2023-02-10 12:58:00

Headers

• El Header será obligatorio para consumir el EP ya que si no se cuenta con ello, retornará error.
• El EP está restringido a un máximo de 8 horas de diferencia entre los parámetros start_time y end_time, esto debido a la cantidad de datos que se retornan.

Estructura del Diccionario

• "timestamp" -> Datetime, formato (YY-MM-DD hh:mm:ss)
• "latitude" -> Float
• "longitude" -> Float
• "speed" -> Integer
• "avl" -> String, CharField (tamaño máximo = 7)
• "curso" -> Integer, valores posibles (de 0 a 360).
• "altitud" -> Integer
• "ign" -> Integer, valores posibles (motor apagado = 0, motor encendido = 1)

2.1 Correcto

SUCESSFUL

Status Code: 200 OK

• Si el token fue el correcto, la petición devolverá la data ordenada de manera decreciente con respecto al timestamp. Del más reciente al más antiguo.

[
    {
        "timestamp": "2023-02-10 11:58:07",
        "latitude": -16.975501667,
        "longitude": -72.068116667,
        "speed": 34,
        "avl": "VAV-727",
        "curso": 18,
        "altitud": 347,
        "ign": 1
    },
    {
        "timestamp": "2023-02-10 11:58:22",
        "latitude": -16.974188333,
        "longitude": -72.067813333,
        "speed": 35,
        "avl": "VAV-727",
        "curso": 8,
        "altitud": 353,
        "ign": 1
    },
]

2.2 Incorrecto (Token Inválido)

ERROR

Status Code: 401 Unauthorized

{
    "detail": "Invalid token."
}

2.3 Incorrecto (No Token)

ERROR

Status Code: 401 Unauthorized

• Si el token no es enviado, el EP retornará un error.

{
    "detail": "Authentication credentials were not provided."
}

2.4 Incorrecto (Formato Inválido)

ERROR

Status Code: 400 Bad Request

• Si el formato no es correcto, el EP retornará un error.

{
    "detail": "El formato de \"fecha de inicio\" o \"fecha de fin\" no son correctos, por favor revisar que cumplan el siguiente formato yyyy-mm-dd hh:mm:ss"
}

2.5 Incorrecto (Fechas Incorrectas)

ERROR

Status Code: 400 Bad Request

• Si el parámetro start_time es mayor que end_time, el EP retornará un error, ya que esto no es posible.

{
    "detail": "\"fecha de inicio\" no puede ser mayor o igual que \"fecha de fin\""
}

2.6 Incorrecto (Diferencia de Fechas Incorrectas)

ERROR

Status Code: 400 Bad Request

• Si el la diferecia en tiempo de los parámetros start_time y end_time superan las 8 horas, el EP retornará un error.

{
    "detail": "La diferencia del filtro de \"fecha de inicio\" y \"fecha de fin\" no puede ser mayor a 8 horas"
}