List Customers

Usa esto para ponerte al día con cada cliente que haya cambiado desde tu última sincronización.

The following endpoint can be used to retrieve the details of Customers within the Hyfin application.


Punto Final

The following endpoint can be used to retrieve Customers. You must replace the {base_url} , {site_id} and {updated_after} variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/customers?updated_after={updated_after}

Solicitar parámetros de consulta
Campo
Tipo
Descripción
updated_after
El inicio del rango de tiempo de la consulta (exclusivo). En solicitudes posteriores, envía el nextUpdatedAfter de la respuesta anterior. A diferencia de otras marcas de tiempo, requiere exactamente tres dígitos de milisegundos y una zona horaria, ya sea Z o un desfase como +05:00. En una cadena de consulta, envía + como %2B. Cualquier otro formato, o una hora en el futuro, se rechaza. Las consultas buscan hacia atrás un máximo de 7 días. Una marca de tiempo más antigua se adelanta al límite en lugar de rechazarse, por lo que no se devuelven los registros que cambiaron por última vez antes de ese límite. Si se omite este parámetro, se devuelven los últimos 7 días. Una integración que devuelve el nextUpdatedAfter de cada respuesta nunca llega al límite. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
Respuesta
Campo
Tipo
Descripción
recordsMatched
Number
El número de registros que coincidieron con los parámetros de la consulta.
recordsReturned
Number
El número de registros que fueron devueltos.
nextUpdatedAfter
El valor que se debe enviar como updated_after en la siguiente consulta. Cuando coincidieron más registros de los que devolvió esta página, es 1 milisegundo antes de la hora de actualización del último registro, de modo que ese registro vuelve a aparecer en la siguiente página: elimina duplicados por id. Cuando esta página devolvió todos los registros coincidentes, es la hora de la consulta, y la siguiente consulta devuelve solo los registros modificados desde entonces. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
queryTime
La hora en que se ejecutó la consulta. Cuando la página devolvió todos los registros coincidentes, también es el nextUpdatedAfter. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
limit
Number
El número máximo de registros que devolverá una sola respuesta. Cuando recordsReturned es igual a este valor, es probable que haya más registros en espera y se debe hacer otra solicitud con el nextUpdatedAfter devuelto.
records
Los registros que coincidieron con los parámetros de la consulta, primero la actualización más antigua.
success
Boolean
Indica si la consulta se completó correctamente.

Ver también