Skip to content

Admin Panel APIs (1.0.0)

The Admin Panel APIs provide endpoints for managing organizations, users, roles, system configurations, and security features. They also support timestamp-based access controls and geo-fencing to enhance security and compliance.

Download OpenAPI description
Languages
Servers
Mock server
https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/
Production server
https://api.ivalt.com/admin/public/api/

Admin Panel Apis

Admin Panel APIs for organization, user, and role management. Includes system configurations, security controls, timestamps, and geo-fencing features.

Operations

Update Timeslot

Request

Update an existing timeslot

Security
ApiKeyAuth
Path
timeslot_idintegerrequired

Timeslot ID

Example: 563
Bodyapplication/json

Request payload for update PUT.

timezoneobjectrequired

Timezone of put /timeslot/{timeslot_id}/update request.

timezone.​valuestringrequired

Value of put /timeslot/{timeslot_id}/update request → timezone.

timezone.​labelstringrequired

Label of put /timeslot/{timeslot_id}/update request → timezone.

timezone.​offsetnumberrequired

Offset of put /timeslot/{timeslot_id}/update request → timezone.

timezone.​abbrevstringrequired

Abbrev of put /timeslot/{timeslot_id}/update request → timezone.

timezone.​altNamestringrequired

Altname of put /timeslot/{timeslot_id}/update request → timezone.

start_timestringrequired

Start time of put /timeslot/{timeslot_id}/update request.

end_timestringrequired

End time of put /timeslot/{timeslot_id}/update request.

statusintegerrequired

Status of put /timeslot/{timeslot_id}/update request.

curl -i -X PUT \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/timeslot/563/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "timezone": {
      "value": "Asia/Kolkata",
      "label": "(GMT+5:30) Chennai, Kolkata, Mumbai, New Delhi",
      "offset": 5.5,
      "abbrev": "IST",
      "altName": "India Standard Time"
    },
    "start_time": "2024-06-04T18:30:00.081Z",
    "end_time": "2024-06-05T11:30:00.081Z",
    "status": 0
  }'

Responses

Successful operation

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Operation completed successfully" }

Delete Timeslot

Request

Delete an existing timeslot

Security
ApiKeyAuth
Path
timeslot_idintegerrequired

Timeslot ID

Example: 563
curl -i -X DELETE \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/timeslot/563/delete \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Operation completed successfully" }

Get User Timeslots

Request

Fetches all timeslots assigned to a specific user.

Security
ApiKeyAuth
Path
userIdstringrequired

Path parameter: userId

curl -i -X GET \
  'https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/user/{userId}/timeslots' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Timeslots retrieved successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Get User Timeslots" }