Saltar al contenido principal

GET | /

Función que Realiza

Devuelve un array con un listado de clientes que cumplen con las siguientes condiciones:

  • No está suspendido.
  • Su "ol" es false.
  • Su frecuencia no debe ser "Deposito".

Funcionamiento​

  • URL Completa: {domain}/api/v1/clients/
  • Acción: GET
  • Requiere Api-Key?: Si
  • Requiere una Sesión?: Si
  • Recibe datos mediante: Query
    • Cantidad de datos: 1
  • Responde con contenido?: Si
  • Responde únicamente con código de estado?: No
    • Código: 200 | Ok
  • Códigos de error: Vea la sección Errores

Contenido que recibe por Query​

frequency = Enum('Lunes', 'Martes', 'Miercoles', 'Jueves', 'Viernes', 'Sábado'),
info

No importa si se ingresa la fecuencia con mayúsculas, minúsculas o con tildes, la api convierte todo a minúsculas y remueve las tildes al verificar.

Contenido que devuelve por Body​

[
  {
    "id": Int,
    "socialReason": "String",
    "address": "String",
    "groupingChannel": "String",
    "status": "String",
    "frequency": "String",
    "gec": "String",
    "coords": {
      "latitude": "String",
      "longitude": "String"
    }
  }
]

Códigos de Error​

HTTP CodeCustom CodeMessage
500UNEXPECTED_ERRORNo fue posible extraer el usuario de la solicitud.