Solicitudes de servicio

Actualizado el 4 de septiembre de 2026APIDescargar PDF

Usar con IA

Ver como Markdown Abrir en Claude Abrir en ChatGPT

En esta página

GET /serviceRequests
Parámetros
Respuestas
POST /serviceRequests
Cuerpo de la solicitud
Respuestas
GET /serviceRequests/forms
Respuestas
GET /serviceRequests/{serviceRequestId}
Parámetros
Respuestas
PUT /serviceRequests/{serviceRequestId}
Parámetros
Cuerpo de la solicitud
Respuestas
DELETE /serviceRequests/{serviceRequestId}
Parámetros
Respuestas

Operaciones sobre recursos de solicitudes de servicio. 6 puntos finales, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado según lo descrito en Autenticación.

GET /serviceRequests

Obtener todas las solicitudes de servicio creadas por el usuario actual

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
page	query	any	no
limit	query	any	no

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "data": [
    {
      "uniqueId": "b12847425fc6454bb2154ef4cc9b2ce9",
      "category": "tower",
      "subCategory": "new_tower",
      "data": [
        {
          "name": "project_address",
          "label": "service_requests.new_tower.project_address",
          "type": "text",
          "value": "#21, 1st Floor",
          "required": true
        }
      ],
      "status": "Pending",
      "allAvailableStatus": [
        {
          "name": "pending",
          "label": "Pending",
          "icon": "pending",
          "color": "#606060"
        }
      ],
      "serviceProviderId": "e7f417cf4a434b5093a8173cdb50005f",
      "userId": "70cb24d36f86424b802873af7e78c2d3",
      "createdOn": 1715174099197
    },
    {
      "uniqueId": "b06cfbd7f80a4f76843b6443cedadea4",
      "category": "tower",
      "subCategory": "new_tower",
      "data": [
        {
          "name": "project_address",
          "label": "service_requests.new_tower.project_address",
          "type": "text",
          "value": "#21, 1st Floor",
          "required": true
        }
      ],
      "status": "Pending",
      "allAvailableStatus": [
        {
          "name": "pending",
          "label": "Pending",
          "icon": "pending",
          "color": "#606060"
        }
      ],
      "serviceProviderId": "e7f417cf4a434b5093a8173cdb50005f",
      "userId": "70cb24d36f86424b802873af7e78c2d3",
      "createdOn": 1715173285960
    },
    {
      "uniqueId": "596ed03dde0a489382ddc1f6cc023f33",
      "category": "tower",
      "subCategory": "new_tower",
      "data": [
        {
          "name": "project_address",
          "label": "service_requests.new_tower.project_address",
          "type": "text",
          "value": "#21, 1st Floor",
          "required": true
        }
      ],
      "status": "Pending",
      "allAvailableStatus": [
        {
          "name": "pending",
          "label": "Pending",
          "icon": "pending",
          "color": "#606060"
        }
      ],
      "serviceProviderId": "e7f417cf4a434b5093a8173cdb50005f",
      "userId": "70cb24d36f86424b802873af7e78c2d3",
      "createdOn": 1715173282225
    }
  ],
  "totalPages": 1,
  "currentPage": 1
}

POST /serviceRequests

Agregar una solicitud de servicio

Cuerpo de la solicitud

json

{
  "category": "string",
  "subCategory": "string",
  "data": [
    {
      "name": "string",
      "label": "string",
      "type": "string",
      "value": "string",
      "required": "boolean"
    }
  ],
  "allAvailableStatus": [
    {
      "name": "string",
      "label": "string",
      "icon": "string",
      "color": "string"
    }
  ]
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "result": "serviceRequestId"
}

GET /serviceRequests/forms

Obtener JSON para crear formulario dinámico para solicitudes de servicio

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "categories": [
    {
      "name": "service_requests.tower",
      "subCategories": [
        {
          "name": "service_requests.new_tower",
          "status": [
            {
              "name": "service_requests.pending",
              "icon": "pending",
              "color": "#FF0000"
            },
            {
              "name": "service_requests.in_progress",
              "icon": "pending-actions",
              "color": "#FFA500"
            },
            {
              "name": "service_requests.completed",
              "icon": "check_circle",
              "color": "#00FF00"
            }
          ],
          "fields": [
            {
              "name": "service_requests.location",
              "type": "text",
              "required": true
            },
            {
              "name": "service_requests.description",
              "type": "textarea",
              "required": false
            },
            {
              "name": "service_requests.image",
              "type": "image",
              "required": true
            }
          ]
        }
      ]
    }
  ]
}

GET /serviceRequests/{serviceRequestId}

Obtener una solicitud de servicio con registros

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
serviceRequestId	path	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "data": {
    "_id": "660d3d7fd6e88700127fd3a2",
    "data": [
      {
        "name": "project_address",
        "label": "service_requests.new_tower.project_address",
        "type": "text",
        "value": "#21, 1st Floor",
        "required": true
      }
    ],
    "uniqueId": "6f1917ae16fc4cf19fe9b7ea5fba8878",
    "category": "tower",
    "subCategory": "new_tower",
    "status": "Completed",
    "allAvailableStatus": [
      {
        "name": "pending",
        "label": "Pending",
        "icon": "pending",
        "color": "#606060"
      },
      {
        "name": "Completed",
        "icon": "check-circle",
        "color": "#606060"
      }
    ],
    "serviceProviderId": "e7f417cf4a434b5093a8173cdb50005f",
    "userId": "691fb2115824540aceabdc421244sd",
    "createdOn": 1712143743532,
    "auditLogs": [
      {
        "_id": "660d3d7fd6e88700127fd3a3",
        "action": "Insert",
        "payload": {
          "status": "Pending"
        },
        "userEmail": "admin@web02.io",
        "dateTime": "Wed, 03 Apr 2024 11:29:03 GMT",
        "timeStamp": 1712143743000,
        "actionStatus": "Success",
        "userAction": "SERVICE REQUEST has been added successfully"
      },
      {
        "_id": "661696cecd94a74301c9a001",
        "action": "Update",
        "payload": {
          "status": "Completed"
        },
        "userEmail": "admin@web02.io",
        "dateTime": "Wed, 10 Apr 2024 13:40:30 GMT",
        "timeStamp": 1712756430000,
        "actionStatus": "Success",
        "userAction": "Marked as Completed"
      }
    ]
  }
}

PUT /serviceRequests/{serviceRequestId}

Actualizar una solicitud de servicio

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
serviceRequestId	path	cadena	sí

Cuerpo de la solicitud

json

{
  "category": "string",
  "subCategory": "string",
  "data": [
    {
      "name": "string",
      "label": "string",
      "type": "string",
      "value": "string",
      "required": "boolean"
    }
  ],
  "allAvailableStatus": [
    {
      "name": "string",
      "label": "string",
      "icon": "string",
      "color": "string"
    }
  ]
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "result": "serviceRequestId"
}

DELETE /serviceRequests/{serviceRequestId}

Eliminar una solicitud de servicio

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
serviceRequestId	path	string	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "result": "serviceRequestId"
}

¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.