GET | /request

Función que Realiza

Devuelve un listado de todas las solicitudes junto a sus tareas, materiales y información del cliente.

---

Funcionamiento

• URL Completa: {domain}/api/v1/merch/request
• Acción: GET
• Requiere Api-Key?: Si
• Requiere una Sesión?: Si
• Recibe datos mediante: Query
  • Cantidad de datos: 5
• 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

nota

• Los campos fromDate y toDate son opcionales pero se requiere al menos 1 de ellos.
• Si solo se recibe el campo fromDate se va a devolver un listado desde la fecha ingresada en adelante.
• Si solo se recibe el campo toDate se va a devolver un listado desde todos los elementos previos a la fecha ingresada.

status?     =   Enum('PENDIENTE', 'ASIGNADO', 'COMPLETADO', 'ANULADO'),
dispatchId? =   Int,
fromDate?   =   Date(YYYY-MM-DD),
toDate?     =   Date(YYYY-MM-DD),
page        =   Int,
pageSize    =   Int

Contenido que devuelve

{
  "meta": {
    "page": Int,
    "pageSize": Int,
    "count": Int,
  },
  "requests": [
    {
      "id": "String",
      "dispatchId": Int | null,
      "comments": "String" | null,
      "cancelReason": "String" | null,
      "creationDate": "Date",
      "completedDate": "Date" | null,
      "assignamentDate": "Date" | null,
      "routerUserId": "String" | null,
      "status": "String",
      "user": {
        "id": "String",
        "firstName": "String",
        "lastName": "String"
      },
      "client": {
        "id": Int,
        "socialReason": "String",
        "address": "String",
        "groupingChannel": "String",
        "status": "String",
        "frequency": "String",
        "gec": "String",
        "coords": {
          "latitude": "String",
          "longitude": "String"
        }
      },
      "assignedMerchId": "String" | null,
      "tasks": [
        {
          "id": Int,
          "name": "String",
          "status": "Enum('PENDIENTE', 'INCOMPLETO', 'COMPLETADO')",
          "incompleteReason": "String" | null
        }
      ],
      "materials": [
        {
          "id": Int,
          "description": "String"
        }
      ]
    }
  ]
}

---

Códigos de Error

HTTP Code	Custom Code	Message
422	INVALID_DATE_RANGE	Se requiere al menos un inicio o final de fecha para buscar.