Demandes de service

Mis à jour le 4 septembre 2026APITélécharger le PDF

Utiliser avec une IA

Afficher en Markdown Ouvrir dans Claude Ouvrir dans ChatGPT

Suggérer une modification Obtenir de l’aide

Sur cette page

GET /serviceRequests
Paramètres
Réponses
POST /serviceRequests
Corps de la demande
Réponses
GET /serviceRequests/forms
Réponses
GET /serviceRequests/{serviceRequestId}
Paramètres
Réponses
PUT /serviceRequests/{serviceRequestId}
Paramètres
Corps de la requête
Réponses
DELETE /serviceRequests/{serviceRequestId}
Paramètres
Réponses

Opérations sur les ressources de demandes de service. 6 points de terminaison, chacun relatif à https://api.nxgen.cloud/api/v1 et authentifié comme décrit sous Authentification.

GET /serviceRequests

Récupérer toutes les demandes de service créées par l'utilisateur actuel

Paramètres

Nom	Dans	Type	Obligatoire	Description
page	requête	tout	non
limite	requête	tout	non

Réponses

Statut	Description	Corps
200	Succès
400	Entrée invalide
401	Non autorisé
403	Interdit
404	Non trouvé

Exemple 200 réponse :

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

Ajouter une demande de service

Corps de la demande

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

Réponses

Statut	Description	Corps
200	Succès
400	Entrée invalide
401	Non autorisé
403	Interdit
404	Pas trouvé

Exemple 200 réponse :

json

{
  "result": "serviceRequestId"
}

GET /serviceRequests/forms

Obtenir le JSON pour créer un formulaire dynamique pour les demandes de service

Réponses

Statut	Description	Corps
200	Succès
400	Entrée invalide
401	Non autorisé
403	Interdit
404	Pas trouvé

Exemple 200 réponse :

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}

Obtenir une demande de service avec les journaux

Paramètres

Nom	Dans	Type	Obligatoire	Description
serviceRequestId	path	chaîne	oui

Réponses

Statut	Description	Corps
200	Succès
400	Entrée invalide
401	Non autorisé
403	Interdit
404	Pas trouvé

Exemple 200 réponse:

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}

Mettre à jour une demande de service

Paramètres

Nom	Dans	Type	Obligatoire	Description
serviceRequestId	path	chaîne	oui

Corps de la requête

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

Réponses

Statut	Description	Corps
200	Succès
400	Entrée invalide
401	Non autorisé
403	Interdit
404	Pas trouvé

Exemple 200 réponse:

json

{
  "result": "serviceRequestId"
}

DELETE /serviceRequests/{serviceRequestId}

Supprimer une demande de service

Paramètres

Nom	Dans	Type	Obligatoire	Description
serviceRequestId	path	string	oui

Réponses

Statut	Description	Corps
200	Succès
400	Entrée invalide
401	Non autorisé
403	Interdit
404	Non trouvé

Exemple 200 réponse:

json

{
  "result": "serviceRequestId"
}

Cette page vous a-t-elle été utile ?

Merci — votre retour est transmis à l’équipe responsable de cette page.