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: 7
• 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'),
search? = String,
channel? = String,
gec? = String,
route? = String,
page    = Int,
pageSize = Int

info

1. 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.

2. El campo de busqueda va a filtrar por estas 3 propiedades: codigocliente, razon_social y frecuencia.

   • Se va a filtrar por la propiedad "codigocliente" únicmanete cuando se ingrese un número.

---

Contenido que devuelve por Body

{
  "meta": {
    "page": Int,
    "pageSize": Int,
    "count": Int,
    "total": Int
  },
  "clients": [
    {
      "id": Int,
      "socialReason": "String",
      "address": "String",
      "groupingChannel": "String",
      "status": "String",
      "frequency": "String",
      "gec": "String",
      "coords": {
        "latitude": "String",
        "longitude": "String"
      }
    }
  ]
}

---

Códigos de Error

HTTP Code	Custom Code	Message
422	INVALID_REQUEST_DATA	Los datos enviados son inválidos o insuficientes.
422	INVALID_PAGE_NUMBER	La página debe ser un número.
422	INVALID_PAGESIZE_NUMBER	El tamaño de página debe ser un número.
500	UNEXPECTED_ERROR	No fue posible extraer el usuario de la solicitud.
401	INVALID_API_KEY	La API Key proporcionada no es válida.
401	INVALID_SESSION	La sesión no es válida o ha expirado.
401	INSUFFICIENT_PERMISSIONS	No tienes los permisos suficientes para acceder.