Purpose
The Example Client APIs manage user activities and provide the integration with an operator's back‑end servers.
HTTPS Request and Response formats
Every Request is built according to the HTTPS Method (GET, POST, PUT, PATCH, DELETE) employed by the API, and contains:
- Description of the API.
- Request URI endpoint with parameters (if any) enclosed in curly brackets { }.
- Request cURL syntax.
- Request body attribute definitions (if any) table.
- Request body with headers.
Every Response with appropriate HTTPS Status codes (400 - Bad Request / 500 - Internal Server Error / 404 - Not Found / 200 - Success / etc.) will be in HTTPS and JSON formats and contains:
- Response header and status code.
- Response body in JSON format.
For example, an API using the HTTPS PUT Method would be detailed as follows.
PUTChange an Admin User Password
- Description
- Changes an admin user password.
- Request Endpoint
- PUT https://<Example api server address>/admin/user/{id}/password/change
- Parameters
Parameter Type Use Description id String Required uuid of the admin user. - cURL syntax
curl --include \ --request PUT \ --header "Content-Type: application/json" \ --data-binary "{ \"oldPassword\":\"hello\", \"newPassword\": \"whatever\" }" \ 'https://core.dev.Example.net/api/admin/user/id/password/change'
- PUT body attributes (JSON)
Attribute Type Use Description oldPassword
String Required The old password. newPassword
String Required The new password. - PUT body
Headers: Content-Type: application/json
{ "oldPassword": "hello", "newPassword": "whatever" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "6e99ee70-8094-4c3c-b42f-bd2a7c144b87", "email": "admin@gmail.com", "firstName": "Admin", "loginId": "admin", "lastName": "User", "role": "SUPER_ADMIN" }, "detail": null, "error": false, "message": "Changing admin user password successful" }