Saltar al contenido principal

GET /api/devices/{deviceId}/lastLocation

Este endpoint permite obtener la última ubicación conocida de un dispositivo específico en la aplicación de seguimiento satelital. Es útil para rastrear la ubicación más reciente del dispositivo y obtener detalles sobre esta ubicación.

Detalles de la Solicitud

La solicitud se realiza utilizando el método GET en la URL /api/devices/{deviceId}/lastLocation. Debes reemplazar {deviceId} con el ID real del dispositivo que deseas consultar.

Parámetros de la Solicitud

Este endpoint requiere el parámetro deviceId que debe incluirse en la ruta de la URL.

ParámetroTipoObligatorioDescripción
deviceIdstringEl identificador único del dispositivo a consultar.

Autenticación Requerida

La autenticación requerida para utilizar el endpoint es mediante un token Bearer. Este método de autenticación implica que cada solicitud debe incluir un encabezado de autorización con un token de acceso válido. Este token Bearer actúa como una credencial que verifica la identidad del usuario o aplicación que realiza la solicitud, asegurando que solo las entidades autorizadas puedan modificar la información del usuario. Al requerir este tipo de autenticación, el sistema garantiza un nivel elevado de seguridad y control de acceso, protegiendo los datos de los usuarios contra accesos no autorizados.

Ejemplo de Solicitud

GET /api/devices/device123/lastLocation HTTP/1.1
Host: api.plaspy.com
Authorization: Bearer {token}

Parámetros de Respuesta

La respuesta de este endpoint incluye detalles sobre el éxito de la operación y, en caso de éxito, información sobre la última ubicación del dispositivo solicitado. La respuesta puede variar dependiendo de si la solicitud fue exitosa o si hubo algún error.

CampoTipoObligatorioDescripción
successbooleanIndica si la solicitud fue exitosa.
errorstringNoMensaje de error en caso de que la solicitud falle.
apiUsageintegerNoUso de la API en la solicitud actual.
apiDailyUsageintegerNoUso diario de la API.
lastLocationobjectNoInformación sobre la última ubicación del dispositivo.

Dentro del campo lastLocation, el objeto tiene los siguientes campos:

CampoTipoObligatorioDescripción
dateTimestringFecha y hora de la última ubicación, en formato ISO 8601.
latitudenumberLatitud de la última ubicación.
longitudenumberLongitud de la última ubicación.
speednumberNoVelocidad en la última ubicación.
coursenumberNoCurso (dirección) en la última ubicación.
batteryintegerNoNivel de batería del dispositivo en la última ubicación.
fuelintegerNoNivel de combustible del dispositivo en la última ubicación.
fuel2integerNoNivel de combustible secundario en la última ubicación.
temperaturenumberNoTemperatura medida en la última ubicación.
temperature2numberNoTemperatura secundaria medida en la última ubicación.
sensorTime1integerNoTiempo del sensor 1 en la última ubicación.
sensorTime2integerNoTiempo del sensor 2 en la última ubicación.
sensorTime3integerNoTiempo del sensor 3 en la última ubicación.
sensorTime4integerNoTiempo del sensor 4 en la última ubicación.
inactiveSecondsintegerNoSegundos de inactividad en la última ubicación.
rpmintegerNoRevoluciones por minuto en la última ubicación.
milleagenumberNoKilometraje en la última ubicación.
warningTextsarrayNoTextos de advertencia en la última ubicación.
alertTextsarrayNoTextos de alerta en la última ubicación.
alertsarrayNoAlertas en la última ubicación.
warningsarrayNoAdvertencias en la última ubicación.
hasCriticalAlertbooleanNoIndica si hay alertas críticas en la última ubicación.
attributesobjectNoAtributos adicionales de la última ubicación.
accessoriesAttributesarrayNoAtributos adicionales de accesorios en la última ubicación.
inputsarrayNoEstado de las entradas en la última ubicación.
outputsarrayNoEstado de las salidas en la última ubicación.

Ejemplo de Respuesta Exitosa

{
"success": true,
"apiUsage": 150,
"apiDailyUsage": 3000,
"lastLocation": {
"dateTime": "2024-06-02T08:48:25.009Z",
"latitude": 0,
"longitude": 0,
"speed": 0,
"course": 0,
"battery": 0,
"fuel": 0,
"fuel2": 0,
"temperature": 0,
"temperature2": 0,
"sensorTime1": 0,
"sensorTime2": 0,
"sensorTime3": 0,
"sensorTime4": 0,
"inactiveSeconds": 0,
"rpm": 0,
"milleage": 0,
"warningTexts": [
"string"
],
"alertTexts": [
"string"
],
"alerts": [
"string"
],
"warnings": [
"string"
],
"hasCriticalAlert": true,
"attributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"accessoriesAttributes": [
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
],
"inputs": [
true
],
"outputs": [
true
]
}
}

Ejemplo de Respuesta de Error

Respuesta de Error 400 (Bad Request)

{
"success": false,
"error": "Bad Request",
"apiUsage": 150,
"apiDailyUsage": 3000
}

Respuesta de Error 500 (Internal Server Error)

{
"success": false,
"error": "Internal Server Error",
"apiUsage": 150,
"apiDailyUsage": 3000
}

Este endpoint es esencial para rastrear la última ubicación conocida de un dispositivo dentro del sistema. Permite a los usuarios obtener información detallada y actualizada sobre la última posición registrada de un dispositivo específico, incluyendo atributos personalizados y datos de accesorios.