Listar contratos de plazos
https://carchost.fieldcontrol.com.br/deadlines-contractsLista los contratos de plazos de la cuenta. Los contratos se registran en el Panel del Gestor y se aplican en la creación de la orden.
Requiere los headers
X-Api-KeyyUser-Agent. Límite: 1 solicitud por segundo (más información).
Solicitud
Parámetros de consulta
limitintegerCantidad de ítems por página.
De 1 a 100.Predeterminado: 10.
offsetintegerCantidad de ítems que se omiten.
De 0 a 200000.Predeterminado: 0.
qstringFiltros en el formato campo:valor, separados por espacios (cómo filtrar). Los filtros aceptados están en la tabla de abajo.
Ejemplo: archived:false.
| Filtro | Qué hace |
|---|---|
name | Nombre del contrato, exactamente igual al registrado. Hasta 50 caracteres. |
archived |
|
created_at | Fecha igual a la informada (ISO 8601, UTC). |
created_at>= | Creados a partir de la fecha informada, inclusive. |
created_at<= | Creados hasta la fecha informada, inclusive. |
created_at> | Creados después de la fecha informada. |
created_at< | Creados antes de la fecha informada. |
updated_at | Fecha igual a la informada (ISO 8601, UTC). |
updated_at>= | Modificados a partir de la fecha informada, inclusive. |
updated_at<= | Modificados hasta la fecha informada, inclusive. |
updated_at> | Modificados después de la fecha informada. |
updated_at< | Modificados antes de la fecha informada. |
sortstringOrdenación. El prefijo - invierte el orden.
Valores aceptados: id, created_at, -created_at, updated_at, -updated_at.Predeterminado: id.
Headers
User-AgentstringobligatorioIdentificación de su aplicación.
Ejemplo: MinhaIntegracao/1.0.
Respuestas
- 200
Lista de contratos.
- 401
Clave de API ausente (
Missing API Key) o inválida (Invalid API Key). Consulte Autenticación. - 403
Cuenta bloqueada (
Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación. - 422
Filtro, paginación u ordenación inválidos (parametersValidationErr).
- 429
Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.
- 500
Error inesperado en el servidor.