Service-Anfragen

Aktualisiert am 4. September 2026APIPDF herunterladen

Mit KI verwenden

Als Markdown ansehen In Claude öffnen In ChatGPT öffnen

Auf dieser Seite

GET /serviceRequests
Parameter
Antworten
POST /serviceRequests
Anfragekörper
Antworten
GET /serviceRequests/forms
Antworten
GET /serviceRequests/{serviceRequestId}
Parameter
Antworten
PUT /serviceRequests/{serviceRequestId}
Parameter
Anfragekörper
Antworten
DELETE /serviceRequests/{serviceRequestId}
Parameter
Antworten

Operationen an Service-Anfragen-Ressourcen. 6 Endpunkte, jeweils relativ zu https://api.nxgen.cloud/api/v1 und authentifiziert wie unter Authentifizierung.

GET /serviceRequests

Alle Service-Anfragen des aktuellen Benutzers abrufen

Parameter

Name	In	Typ	Erforderlich	Beschreibung
page	query	beliebig	nein
Limit	query	beliebig	nein

Antworten

Status	Beschreibung	Inhalt
200	Erfolg
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200 Antwort:

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

Service-Anfragen hinzufügen

Anfragekörper

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

Antworten

Status	Beschreibung	Body
200	Erfolg
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200 Antwort:

json

{
  "result": "serviceRequestId"
}

GET /serviceRequests/forms

JSON abrufen, um ein dynamisches Formular für Service-Anfragen zu erstellen

Antworten

Status	Beschreibung	Body
200	Erfolg
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200 Antwort:

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}

Eine Service-Anfrage mit Protokollen abrufen

Parameter

Name	Im	Typ	Erforderlich	Beschreibung
serviceRequestId	Pfad	String	ja

Antworten

Status	Beschreibung	Body
200	Erfolg
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200 Antwort:

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}

Service-Anfrage aktualisieren

Parameter

Name	In	Typ	Erforderlich	Beschreibung
serviceRequestId	path	string	ja

Anfragekörper

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

Antworten

Status	Beschreibung	Inhalt
200	Erfolg
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200 Antwort:

json

{
  "result": "serviceRequestId"
}

DELETE /serviceRequests/{serviceRequestId}

Löschen einer Service-Anfrage

Parameter

Name	In	Typ	Erforderlich	Beschreibung
serviceRequestId	Pfad	String	ja

Antworten

Status	Beschreibung	Inhalt
200	Erfolg
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Example 200 Antwort:

json

{
  "result": "serviceRequestId"
}

War diese Seite hilfreich?

Vielen Dank — Ihr Feedback geht an das Team, das diese Seite betreut.