Skip to main content

Import Client Guide

Swagger UI Details​

Once you’re in the Swagger UI, select Admin from the dropdown menu in the top-right corner.

API Descriptions​

  1. GET /admin/clients
    Retrieves a list of all clients:

    • clientId: Unique identifier for the client.
    • name: Display name shown in dropdowns.
    • disabled: Indicates if the client is disabled or deleted.

  2. PUT /admin/clients
    Creates or updates a client:

    • clientId: Unique identifier for the client.
    • name: Display name.

  3. PUT /admin/clients/{client-id}/parking
    Adds or updates a parking location for a client:

    • client-id: Unique identifier for the client.
    • file: File containing parking details.

    Note: The first column in the parking file must be unique for each client. If a parking with the same ID is imported twice, the latter entry will overwrite the first.

  4. DELETE /admin/clients/{client-id}
    Soft deletes a client, making it inactive:

    • client-id: Unique identifier for the client.

    Note: To reactivate, use the PUT /admin/clients API with the necessary data.

  5. DELETE /admin/clients/{client-id}/parking/{parking-id}
    Soft deletes a specific parking location for a client:

    • client-id: Unique identifier for the client.
    • parking-id: Unique identifier for the parking location.

Steps to Create a Client and Add Parking​

Step 1: Navigate to Swagger UI​

Go to the Swagger UI URL and select Admin from the dropdown.

Step 2: Create or Update a Client​

Expand the PUT /admin/clients endpoint and click Try it out.
Example payload to create a client:

{
  "clientId": "sireto",
  "name": "Sireto"
}

Step 3: Add or Update Parking for a Client​

To add a location, use the PUT /admin/clients/{client-id}/parking endpoint.
Example:

  • client-id: sireto
  • file: Upload the parking file

Repeat this step with a new parking ID as needed.

Deleting a Client or Parking​

Delete a Client​

Use the DELETE /admin/clients/{client-id} endpoint.
Example:

  • client-id: sireto

Delete a Parking​

Use the DELETE /admin/clients/{client-id}/parking/{parking-id} endpoint.
Example:

  • client-id: sireto
  • parking-id: baneshwor-parking

Field Descriptions for Import Sheets​

Parkings​

  • Fill only the first row after the header.
  • Columns after J are for additional details (e.g., specs). Include both title and value to add them under the Specs tab.

Items​

  • Extra details beyond column E are displayed in the Specs tab.

Answers​

  • For multiple referral contacts in an answer, list them horizontally to the right of the answer.

Workflow​

  • If values are the same as the previous row, you may leave them blank.

  • Each action response can have either an Answer or a Next Action.

    Workflow Example

Important Note​

In the example above, the last action Niet binnen laten (which is the next action for the response Geen van bovenstaande) has no further responses for the action.

If an action is only included as a next action for a response, with no further responses for the problem, the Escalation Protocol will be shown instead of a response for that final action.

Image and Attachment URLs​

  • To show an image/attachment, we can include the private sharepoint link which will redirect the user to the sharepoint link and will be able to view the file if the user has access.
  • Including pictures link in specs is also supported.

Video Demonstration of using the APIs​

https://drive.google.com/file/d/1SeufgjAD_qszITFnHn228yfeqzAAb3GS/view?usp=sharing