API: Check-ins

M: Listar Check-ins

Límite de Tasa de Peticiones

Máximo de 10 peticiones por IP en 5 minutos

HTTP GET

https://<hostname>/api/check-ins

URL PARAMETERS

	Nombre	Tipo	Requerido	Descripción
`start_date`	Fecha de inicio	Texto	si	Fecha en formato YYYY-MM-DD
`end_date`	Fecha de fin	Texto	si	Fecha en formato YYYY-MM-DD
`checkin_type`	Tipo de check-in	Lista de números	si	Tipo de check-in: 181 (efectivo), 183 (no efectivo)
`start_time`	Hora de inicio	Texto	no	Hora en formato HH:MM, valor por defecto: "00:00"
`end_time`	Hora de fin	Texto	no	Hora en formato HH:MM, valor por defecto: "23:59"
`start_of_day`	Hora de inicio por día	Texto	no	Hora en formato HH:MM, valor por defecto: "00:00"
`end_of_day`	Hora de fin por día	Texto	no	Hora en formato HH:MM, valor por defecto: "23:59"
`min_duration`	Duración mínima	Numérico	no	Filtrar check-ins por duración mínima
`cellphone_ids`	Lista de celulares	Lista alfanumérica	no	Listado de ids de celulares para filtrar los check-ins
`pois`	Puntos de Interés	Lista alfanumérica	no	Filtrar check-ins por Puntos de Interés

OUTPUT

JSON con los campos:

success: boolean
data: json Lista de objetos de check-in

EJEMPLO CON CURL

$ curl -u <api_key>:<password>
     -X GET
     https://<hostname>/api/check-ins?start_date=2024-01-01&end_date=2024-01-31&checkin_type=181,183

RESPUESTA

{
    "success": true,
    "data": [
        {
            "cellphoneId": "62736",
            "cellphoneDescription": "Johann Gonzales",
            "tripId": "130324740",
            "pointId": "48369645",
            "epoch": 1730907178,
            "poiId": 2578137,
            "photoId": "",
            "signaturePhotoId": null,
            "effective": 1,
            "batPerc": 60,
            "lat": "13.686632244",
            "lon": "-89.22710244",
            "notes": "Capacitación ",
            "duration": null,
            "formResponseId": null
        },
        {
            "cellphoneId": "device2",
            "cellphoneDescription": "Dispositivo Secundario",
            "tripId": "123",
            "pointId": 789,
            "epoch": 1706834400,
            "poiId": 1011,
            "photoId": "12312",
            "signaturePhotoId": "432",
            "effective": 0,
            "batPerc": 72,
            "lat": 14.6421,
            "lon": -90.5132,
            "notes": "Check-in de prueba",
            "duration": 20,
            "formResponseId": "321"
        }
    ]
}

O: Objeto de Check-in

Cada elemento tiene estos campos:

Campo	Descripción
`cellphoneId`	Identificador único del dispositivo móvil
`cellphoneDescription`	Descripción del dispositivo móvil
`tripId`	Identificador del viaje
`pointId`	Identificador del punto de check-in
`epoch`	Timestamp del check-in en formato Unix time
`poiId`	Identificador del Punto de Interés
`photoId`	Identificador de la foto asociada al check-in (si existe)
`signaturePhotoId`	Identificador de la foto de firma asociada al check-in (si existe)
`effective`	Indica si el check-in es efectivo: 1 (sí), 0 (no)
`batPerc`	Porcentaje de batería del dispositivo
`lat`	Latitud del check-in
`lon`	Longitud del check-in
`notes`	Notas o comentarios adicionales del check-in
`duration`	Duración del check-in en unidades de tiempo
`formResponseId`	Identificador de la respuesta de formulario asociada al check-in