Serviceaanvragen

Bijgewerkt op 4 september 2026APIPDF downloaden

Gebruik met AI

Bekijk als Markdown Openen in Claude Openen in ChatGPT

Op deze pagina

GET /serviceRequests
Parameters
Responsen
POST /serviceRequests
Verzoek body
Responsen
GET /serviceRequests/forms
Responses
GET /serviceRequests/{serviceRequestId}
Parameters
Reacties
PUT /serviceRequests/{serviceRequestId}
Parameters
Verzoek body
Responsen
DELETE /serviceRequests/{serviceRequestId}
Parameters
Responsen

Operaties op serviceaanvragen‑resources. 6 eindpunten, elk relatief ten opzichte van https://api.nxgen.cloud/api/v1 en geauthenticeerd zoals beschreven onder Authenticatie.

GET /serviceRequests

Haal alle serviceaanvragen op die door de huidige gebruiker zijn aangemaakt

Parameters

Naam	In	Type	Verplicht	Beschrijving
pagina	query	any	nee
limiet	query	any	nee

Responsen

Status	Beschrijving	Body
200	Succes
400	Ongeldige invoer
401	Niet toegestaan
403	Verboden
404	Niet gevonden

Voorbeeld 200 respons:

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

Voeg een serviceaanvraag toe

Verzoek body

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"
    }
  ]
}

Responsen

Status	Beschrijving	Body
200	Succes
400	Ongeldige invoer
401	Niet geautoriseerd
403	Forbidden
404	Niet gevonden

Example 200 response:

json

{
  "result": "serviceRequestId"
}

GET /serviceRequests/forms

Haal JSON op om dynamisch formulier voor service-verzoeken te maken

Responses

Status	Description	Body
200	Success
400	Ongeldige invoer
401	Niet geautoriseerd
403	Forbidden
404	Niet gevonden

Voorbeeld 200 respons:

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}

Haal een service-verzoek op met logs

Parameters

Naam	In	Type	Verplicht	Beschrijving
serviceRequestId	pad	string	ja

Reacties

Status	Beschrijving	Body
200	Succes
400	Ongeldige invoer
401	Niet toegestaan
403	Verboden
404	Niet gevonden

Voorbeeld 200 respons:

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}

Werk een serviceaanvraag bij

Parameters

Naam	In	Type	Verplicht	Beschrijving
serviceRequestId	path	string	ja

Verzoek body

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"
    }
  ]
}

Responsen

Status	Beschrijving	Body
200	Succes
400	Ongeldige invoer
401	Niet toegestaan
403	Verboden
404	Niet gevonden

Voorbeeld200 respons:

json

{
  "result": "serviceRequestId"
}

DELETE /serviceRequests/{serviceRequestId}

Verwijder een serviceaanvraag

Parameters

Naam	In	Type	Verplicht	Beschrijving
serviceRequestId	path	string	ja

Responsen

Status	Beschrijving	Body
200	Succes
400	Ongeldige invoer
401	Niet geautoriseerd
403	Verboden
404	Niet gevonden

Example 200 respons:

json

{
  "result": "serviceRequestId"
}

Was deze pagina nuttig?

Bedankt — uw feedback gaat naar het team dat deze pagina beheert.