This endpoint is designed to authenticate a user and retrieve their credentials. It accepts a x-www-form-urlencoded request body to send the necessary data for authentication. The response will either return the user's credentials upon successful authentication or an error message if the authentication fails.
url (type: string, required): The API endpoint to connect to.
\ndatabase (type: string, required): The name of the database to access.
\nusername (type: string, required): The username for authentication.
\npassword (type: string, required): The password for authentication.
\nappName (type: string, optional): The name of the application (string).
\nUpon a successful request, the server responds with a status code of 200 and a JSON object containing the user's credentials:
\nresult: An object that includes:
\ncredentials: An object containing:
\ndatabase: The name of the database (string).
\nuserName: The username of the authenticated user (string).
\nsessionId: The session ID for the current user session (string).
\ncustomerId: The ID of the customer (string).
\nappName: The name of the application (string).
\nIn case of an error, the response will include an error field with a description of the issue.
\nEnsure that the correct credentials are provided for successful authentication.
\nThe response may vary based on the authentication result, either returning user credentials or an error message.
\nThis endpoint is utilized to submit a request that may involve user credentials or session information. The request is sent using the x-www-form-urlencoded content type. It is essential to include the necessary parameters to ensure successful processing of the request.
The request body should be formatted as key-value pairs. The following parameters are required for authentication:
\ndatabase (text): The name of the database the user is trying to access.
\nuserName (text): The username of the user attempting to authenticate.
\nsessionId (text): The unique identifier for the user's session.
\ncustomerId (text): The unique identifier for the customer associated with the user.
\nserver: my.geotab.com
\nPlease ensure to include these parameters in future requests to facilitate proper functionality.
\nHere is an example of how the request should be structured:
\nPOST {{url}}\nContent-Type: application/x-www-form-urlencoded\ndatabase=myDatabase&userName=myUser&sessionId=mySession&customerId=myCustomer\n\nThe response from this endpoint can be in one of the following formats:
\n{ \"result\": { \"credentials\": { \"database\": \"\", \"userName\": \"\", \"sessionId\": \"\", \"customerId\": \"\" } }}
\ndatabase, userName, sessionId, and customerId.{ \"error\": \"\" }
\nerror field.Ensure that the request body includes all required parameters for a successful response.
\nHandle both success and error responses appropriately in your application.
\nThis endpoint allows you to retrieve job information. You can use it to fetch all jobs or filter the results based on specific criteria such as date ranges, statuses, and pagination settings.
\nRequest Body Parameters:
\nid (optional, string): The unique identifier for a specific job.
deviceSearch (optional, Ref): A reference to the device associated with the job.
fromDate (optional, string): The start date for filtering jobs based on their due date.
toDate (optional, string): The end date for filtering jobs based on their due date.
scheduledFrom (optional, string): The start date for filtering jobs based on their scheduled date (driver assignment).
scheduledTo (optional, string): The end date for filtering jobs based on their scheduled date (driver assignment).
updatedFrom (optional, string): The start date for filtering jobs based on their last modification date.
updatedTo (optional, string): The end date for filtering jobs based on their last modification date.
statuses (optional, JobStatus[]): An array of job statuses to filter the results.
offset (optional, number): The number of records to skip before starting to collect the result set.
limit (optional, number): The maximum number of records to return.
Response Structure:
\nThe response will contain a result array with job details, including attributes such as id, name, number, driver, status, createdDate, createdBy, modifiedDate, modifiedBy, dueDate, and reference. Each job may also include an array of stops, which consist of latitude, longitude, name, address, customerId, and work orders. The work orders will have their own attributes, including id, form, notes, number, and products. Additionally, the response provides estimated time of arrival (ETA) and actual metrics related to the job.
This endpoint allows you to add a new job to the system. In addition to the required credentials, the method requires a minimum of two parameters:
\ntypeName: The type of entity being added.
\nentity: The job entity itself. It consists of fields like stops, deviceId, reference, dueDate, etc.
\nUpon a successful request, the API will return a JSON object containing the following structure:
\n{\n \"result\": {\n \"id\": \"<job_id>\"\n }\n}\n\nWhere is the unique identifier for the newly created job.
\nEnsure that all required fields in the Job interface are populated correctly to avoid validation errors.
\nThe response will include the id of the newly created job, which can be used for further operations.
This endpoint allows you to modify a job object in the database. The job must be identified by its id, which should be included in the request payload.
Request Parameters:
\nx-www-form-urlencoded.Expected Response:
\n{} indicating that the request was successful.Notes:
\nEnsure that the id of the job you wish to modify is populated in the request.
Additional job details such as name, reference, dueDate, scheduledDate, createdDate, createdBy, modifiedDate, modifiedBy, stops, number, status, driver, vehicleId, recurring, and notes can also be included in the request payload to update the job details accordingly.
This endpoint allows you to delete a jobfrom the system. In addition to the required credentials, the method requires a minimum of three parameters:
\nmethod: The type of method.
\ntypeName: The type of entity being added.
\nentity: The job entity itself. It consists of id of the Job to be deleted.
\nExpected Response:
The response will be an empty JSON object {} indicating that the operation was successful.
Ensure that the id field is provided in the request to successfully remove the job and its associated data.
This HTTP POST request is designed to execute a specific action on a given type. It allows clients to perform operations defined by the typeName and actionName parameters, passing any necessary arguments as part of the request.
The request body should be sent as x-www-form-urlencoded. It is expected to contain the following parameters:
typeName (string): The name of the type on which the action is to be executed.
\nactionName (string): The name of the action that needs to be performed.
\narguments (object): An object containing key-value pairs that represent the arguments required for the action.
\nThe response from this request will vary based on the action executed. It typically includes a status indicating the success or failure of the action, along with any relevant data returned from the operation.
\nEnsure that you format your request body correctly to avoid errors during execution.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a4042db4-8aaa-4725-8987-87cc044d89b7","name":"Submit Work Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Execute\",\n \"params\": {\n \"typeName\": \"Job\",\n \"actionName\": \"Submit\",\n \"arguments\": {\n \"jobId\": \"job_id\",\n \"workOrderId\": \"work_order_id\",\n \"data\": {},\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n }\n },\n \"type\": \"trax\"\n}","type":"text"}]},"url":"https://one-service.zenduit.com/api/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"1b3432c1-0c9f-47f7-867d-8703d10e5caa"},{"name":"Assign Device","id":"789ff1b4-281a-4a29-ba0c-c8d5c897eb25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"AssignDevice\",\n \"entity\": {\n \"jobId\": \"jobId\",\n \"deviceId\": \"deviceId\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}","description":"This HTTP POST request is designed to assign a specific device to an job
\nThe request body should be sent as x-www-form-urlencoded. It is expected to contain the following parameters:
typeName (string): The name of the type on which the action is to be executed.
\nentity (object): An object containing key-value pairs that represent the arguments required for the action.
\nThe response from this request will vary based on the action executed. It typically includes a status indicating the success or failure of the action, along with any relevant data returned from the operation.
\nEnsure that you format your request body correctly to avoid errors during execution.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f6a0e405-1b27-4273-9399-8e9d8136ebc9","name":"Assign Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"AssignDevice\",\n \"entity\": {\n \"jobId\": \"jobId\",\n \"deviceId\": \"deviceId\"\n },\n \"credentials\": {\n \"sessionId\": \"sessionId\"\n }\n },\n \"type\": \"trax\"\n}","type":"text"}]},"url":"https://one-service.zenduit.com/api/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"789ff1b4-281a-4a29-ba0c-c8d5c897eb25"},{"name":"Add Stop","id":"cd531108-5ee0-4bd6-92fd-abf382e46c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"AddStop\",\n \"entity\": {\n \"jobId\": \"JobId\",\n \"stop\": {\n \"name\": \"Test location\",\n \"address\": \"Test location\",\n \"latitude\": \"43.714317645724186\",\n \"longitude\": \"-79.45494614807927\"\n }\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}","description":"This HTTP POST request is designed to add stop into job. It allows clients to perform operations defined by the typeName and entity parameters, passing any necessary arguments as part of the request.
The request body should be sent as x-www-form-urlencoded. It is expected to contain the following parameters:
typeName (string): The name of the type on which the action is to be executed.
\nentity (object): An object containing key-value pairs that represent the arguments required for the action.
\nThe response from this request will vary based on the action executed. It typically includes a status indicating the success or failure of the action, along with any relevant data returned from the operation.
\nEnsure that you format your request body correctly to avoid errors during execution.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"e327fa16-59c7-4cdb-b42c-e180574ddfc0","name":"Add Stop","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"AddStop\",\n \"entity\": {\n \"jobId\": \"JobId\",\n \"stop\": {\n \"name\": \"Test location\",\n \"latitude\": \"43.714317645724186\",\n \"longitude\": \"-79.45494614807927\",\n \"address\":: \"Test location address\"\n }\n },\n \"credentials\": {\n \"sessionId\": \"sessionId\"\n }\n },\n \"type\": \"trax\"\n}","type":"text"}]},"url":"https://one-service.zenduit.com/api/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"stopId\": \"stopId\"\n}"}],"_postman_id":"cd531108-5ee0-4bd6-92fd-abf382e46c94"},{"name":"Delete Stop","id":"d5c6cd2d-205c-4d6c-96b1-fbe810290031","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"DeleteStop\",\n \"entity\": {\n \"jobId\": \"jobId\",\n \"stopId\": \"stopId\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}","description":"This HTTP POST request is designed to delete stop from the job.
\nThe request body should be sent as x-www-form-urlencoded. It is expected to contain the following parameters:
typeName (string): The name of the type on which the action is to be executed.
\nentity (object): An object containing key-value pairs that represent the arguments required for the action.
\nThe response from this request will vary based on the action executed. It typically includes a status indicating the success or failure of the action, along with any relevant data returned from the operation.
\nEnsure that you format your request body correctly to avoid errors during execution.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ee236b53-cbdb-4331-9155-9f096d95400b","name":"Delete Stop","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"DeleteStop\",\n \"entity\": {\n \"jobId\": \"jobId\",\n \"stopId\": \"stopId\"\n },\n \"credentials\": {\n \"sessionId\": \"sessionId\"\n }\n },\n \"type\": \"trax\"\n}","type":"text"}]},"url":"https://one-service.zenduit.com/api/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"d5c6cd2d-205c-4d6c-96b1-fbe810290031"}],"id":"52b9fb9c-c936-4a22-963d-b744155807cc","description":"search
\nentity
\nThis method is an HTTP POST request to the endpoint {{url}}. It can be utilized to retrieve all devices or a specific subset of devices based on the provided parameters.
Request Body:
The request body should be formatted as x-www-form-urlencoded. The following parameters can be included in the search object:
comment (string, optional): A comment related to the device search.
deviceType (string, optional): The type of device to filter the search.
fromDate (string, optional): The start date for filtering devices.
toDate (string, optional): The end date for filtering devices.
groups (Array, optional): An array of groups to filter the devices.
licensePlate (string, optional): The license plate number to filter the devices.
name (string, optional): The name of the device to filter the search.
assetTag (string, optional): The type of asset associated with the device. Accepts predefined values: Vehicle, Container, Trailer, or Equipment. Custom asset types are returned as UUIDs (e.g., 431f0e20-d20a-11f0-8a08-1d3e78fdd21d). Defaults to Vehicle if not specified. Can be used to filter the search.
serialNumber (string, optional): The serial number of the device to filter the search.
vehicleIdentificationNumber (string, optional): The vehicle identification number for filtering.
id (string, optional): The unique identifier for the device.
customField[] (string, optional): The custom device parameter. is a name of custom field
licensePlate Vehicleβs registration number
year Year the vehicle was manufactured
manufacturer Company that built the vehicle (e.g., Toyota, Ford)
model Specific product model name
color Exterior color
floor Floor id of indoor tracking (custom map id)
comments Additional notes or observations about the vehicle
engineHours: { min?: number; max?: number } - engine hours search filter with max and min values
status : vehicle status. Possible values: \"moving\" | \"stopped\"
driver: Optional string - ID or name of the driver associated with the device
Expected Response:
On success, the response will return a status code of 200 and will be in application/json format. The response structure will be as follows:
{\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"serialNumber\": \"\",\n \"secondSerialNumber\": \"\",\n \"hardwareId\": 0,\n \"productId\": \"\",\n \"groups\": [],\n \"deviceType\": \"\",\n \"activeFrom\": \"\",\n \"activeTo\": \"\",\n \"deviceFlags\": [],\n \"devicePlans\": []\n }\n ]\n}\n\nThe result array contains objects representing the devices, with various attributes such as id, name, serialNumber, and more.
This API endpoint allows you to register a new device for a customer on the ZenduOne platform. By using this request, you can provide the necessary details about the device that you want to add.
\nRequest Body Parameters:
\nThe request body must be sent in x-www-form-urlencoded format. Here are the expected parameters:
name (text): The name of the device being added.
deviceType (text): The type of the device (e.g., smartphone, tablet, etc.).
serialNumber (text): The unique serial number of the device.
assetTag (text): The tag assigned to the device.
Response Structure:
Upon a successful request, the API will return a JSON object containing the result of the operation. The expected response structure is as follows:
{\n \"result\": {\n \"id\": \"<device_id>\"\n }\n}\n\nWhere is the unique identifier assigned to the newly added device.
\nMake sure to provide all required parameters in the request body to ensure successful registration of the device.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b235c471-1780-4b09-8b35-badb1d781ce7","name":"Add Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Add\",\n \"params\": {\n \"typeName\": \"Device\",\n \"entity\": { \n \"name\": \"device name\",\n \"serialNumber\": \"serial\",\n \"deviceType\": \"custom\",\n \"assetTag\": \"Vehicle\"\n },\n \"credentials\": {\n \"sessionId\": \"sessionId\",\n \"appName\": \"appName\"\n }\n },\n \"type\": \"trax\"\n }","type":"text"}]},"url":"https://one-service.zenduit.com/api/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jun 2022 11:31:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"X-HTTP-Method-Override"},{"key":"etag","value":"W/\"645c-zQ+QxyT7kEHcOdhrB1KkhyAltL8\""},{"key":"via","value":"1.1 google"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=cpUfxmXf65T8T4MBbzhkSRGXLPviAwp7bITZIxHlI7nJDrGRk9aMPsOWPzzaEBQmYNp9lIpsZRJZ%2F97nJcdt77JsYYH%2B2o9GZOG2%2B%2BoKRlkMUmy7iD48%2FOLssxgp%2BTJS40QmDx6UUBF6\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"722e55707cc99b3f-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": { \"id\": \"id\" }\n}"}],"_postman_id":"7e68c75c-b5fb-4b11-a31a-27da32063710"},{"name":"Get Devices Status","id":"2c242a5c-3cfd-47a0-a951-4fe05c6cc4ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Get\",\n \"params\": {\n \"typeName\": \"DeviceStatusInfo\",\n \"search\": {},\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}","description":"This endpoint is used to submit a request for tracking the status of a specific device and its associated driver. The request is made via an HTTP POST method, and it expects parameters in an x-www-form-urlencoded format.
\nThe request body is expected to contain the following parameters:
\nid (string, optional): Id of the device.
\ndeviceType (string, optional): Type of the device.
\ngroups (list of ref, options): List of ref of groups.
\nUpon a successful request, the API will return a JSON response containing the following structure:
\nresult: An array of objects, where each object contains:
\ndevice: An object that includes:
\ndriver: An object that includes:
\nisDriving (boolean): Indicates whether the driver is currently driving.
\nisDeviceCommunicating (boolean): Indicates whether the device is currently communicating.
\nlatitude (number): The current latitude of the device.
\nlongitude (number): The current longitude of the device.
\nspeed (number): The current speed of the device.
\nbearing (number): The direction in which the device is moving.
\ndateTime (string): A timestamp indicating when the data was recorded.
\ncameraStatus (string): The status of the device's camera.
\nodometer (number): The total distance traveled by the device.
\nengineHours (number): The total hours the engine has been running.
\nThis endpoint is essential for tracking and managing the real-time status of devices and their drivers.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"67b19033-d780-4eb4-80f0-f61819775117","name":"Get Devices Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Get\",\n \"params\": {\n \"typeName\": \"DeviceStatusInfo\",\n \"search\": {},\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"\"\n}","type":"text"}]},"url":"https://one-service.zenduit.com/api/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jun 2022 11:34:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"X-HTTP-Method-Override"},{"key":"etag","value":"W/\"4b31-j3z0PJHFggbfIv2eqF58v55YPR0\""},{"key":"via","value":"1.1 google"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=xZ%2F4aktIjR8xYYt1rfwK8Mwh63CtKszRtL4E%2FRNX0XupUVKAtAu7jADHMAPIR1scZ0btBP%2FBA75cBrA%2FRoByyGmZPhN1N6YCyltPYs%2Fe3TkA7HVh9e3ssUTWB5zWioMm0N19UA5HyBAx\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"722e59c0f8bf9b3f-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"device\": {\n \"id\": \"deviceId\"\n },\n \"driver\": {\n \"id\": \"\"\n },\n \"isDriving\": false,\n \"isDeviceCommunicating\": false,\n \"latitude\": 0,\n \"longitude\": 0,\n \"speed\": 0,\n \"bearing\": 67.32747489588175,\n \"dateTime\": \"2025-07-04T12:27:08.853Z\",\n \"cameraStatus\": \"offline\",\n \"odometer\": 57719.12485161538,\n \"engineHours\": 5468.202190277481,\n \"ignition\": false\n }\n ]\n}"}],"_postman_id":"2c242a5c-3cfd-47a0-a951-4fe05c6cc4ae"},{"name":"Assign Driver","id":"ba255f53-1ac0-43ad-a106-5c831890dae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"productType","value":""},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"JSON-RPC","value":"{\n \"method\": \"AssignDriver\",\n \"params\": {\n \"typeName\": \"Device\",\n \"entity\": {\n \"id\": \"a2cc1381-e7e1-11e6-860b-3f6fca1f901c\",\n \"userId\": \"2abc6ce0-3fa9-11f0-87da-51b7571ba48a\",\n \"additionalUsers\": [\"f3c9ca10-6fc1-11e9-b0d6-352b7bccd726\", \"98101540-b7d5-11eb-916f-aba5c705772d\"]\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\",\n \"appName\":\"{{appName}}\"\n }\n },\n \"type\": \"trax\"\n }"}]},"url":"{{url}}","description":"This API endpoint is used to assign one primary driver and optional additional drivers to a specific device. This ensures accurate trip logging, driver behavior tracking, and driver-based reporting.
\nThe request body must specify the details of the device and the drivers to be assigned.
\nid (string):
The unique identifier of the device to which drivers are being assigned. (Required)
userId (string):
The identifier of the primary driver being assigned to the device. (Optional)
If omitted, the device will not have a primary driver unless additional drivers are provided.
additionalUsers (array of string):
A list of IDs representing additional drivers assigned to the device. (Optional)
NOTE: At least one of parameters, userId or additionalUsers must be provided.
id must reference a valid device.
At least one of the following must be present:
\nuserId
additionalUsers
additionalUsers cannot exceed 4 values.
Driver assignment will replace the existing driver configuration for the device.
\nNote: If a driver who is currently assigned as the primary driver of another device is assigned as the primary driver to a new device, the system will automatically remove the driverβs primary assignment from the original device and reassign them as the primary driver of the new device. This ensures that a driver can only be the primary driver of one device at a time.
\nUpon success, the API confirms that the device-driver associations have been updated.
If any parameter is invalid, the response will contain an error message explaining the issue.
This API endpoint is used to remove one or more drivers from a device. Drivers can be removed individually or in bulk. If the primary driver is removed, all additional (secondary) drivers will also be removed automatically.
\nThe request body must specify the device and the drivers to remove.
\nid (string):
The unique identifier of the device from which drivers need to be removed. (Required)
userIds (array of string):
A list of driver IDs that should be removed from the device. (Required)
Example: [\"98101590-b7d5-11eb-916f-aba5c705772d\", \"00101540-b7d5-11eb-916f-aba5c705772f\"]
id must be a valid device ID.
userIds must contain at least one driver ID.
If any of the given userIds belongs to the primary driver,
then all secondary drivers assigned to the same device will also be removed automatically.
This HTTP POST request is designed to retrieve forms from the server. It can be utilized to return all forms or a specific form.
\nPurpose of the Request:
The primary purpose of this request is to allow users to access and manage forms within the application.
Expected Input Parameters inside search****:
Response Structure: The response from the API will be a JSON object containing the following fields:
\n_id: A unique identifier for the resource, typically used for database operations.
\nname: A human-readable name associated with the resource.
\nid: A globally unique identifier for the resource, often used for referencing in other systems.
\nUsage Notes:
\nThis HTTP POST request is designed to retrieve submissions from the server. It can be utilized to return all submissions, a specific submission, or a subset of forms based on the parameters provided.
\nPurpose of the Request:
The primary purpose of this request is to allow users to access and manage submissions within the application. It serves as a crucial endpoint for retrieving form data for various use cases, such as displaying submissions to users.
The request body should be formatted as x-www-form-urlencoded. The following parameters can be included in the search object:
id (string, optional): The unique identifier of the record to filter the search. Note: When id is provided, a single object is returned.
driverId (string, optional): The driver's unique identifier to filter the search results.
status (string, optional): The status of the record to filter the search. Possible values: \"open\" | \"rejected\" | \"completed\".
dateFrom (string, optional): The start date for filtering records. Must be in ISO 8601 format (e.g., \"2025-09-25T13:43:59.722Z\"). Note: Must be used together with dateTo.
dateTo (string, optional): The end date for filtering records. Must be in ISO 8601 format (e.g., \"2025-09-25T13:43:59.722Z\"). Note: Must be used together with dateFrom.
createdDateFrom (string, optional): The start date for filtering by creation date. Must be in ISO 8601 format (e.g., \"2025-09-25T13:43:59.722Z\"). Note: Must be used together with createdDateTo.
createdDateTo (string, optional): The end date for filtering by creation date. Must be in ISO 8601 format (e.g., \"2025-09-25T13:43:59.722Z\"). Note: Must be used together with createdDateFrom.
rejectedDateFrom (string, optional): The start date for filtering by rejection date. Must be in ISO 8601 format (e.g., \"2025-09-25T13:43:59.722Z\"). Note: Must be used together with rejectedDateTo.
rejectedDateTo (string, optional): The end date for filtering by rejection date. Must be in ISO 8601 format (e.g., \"2025-09-25T13:43:59.722Z\"). Note: Must be used together with rejectedDateFrom.
updatedDateFrom (string, optional): The start date for filtering by last update date. Must be in ISO 8601 format (e.g., \"2025-09-25T13:43:59.722Z\"). Note: Must be used together with updatedDateTo.
updatedDateTo (string, optional): The end date for filtering by last update date. Must be in ISO 8601 format (e.g., \"2025-09-25T13:43:59.722Z\"). Note: Must be used together with updatedDateFrom.
offset (number, optional): The number of records to skip for pagination. Default value is 0.
limit (number, optional): The maximum number of records to return. Default value is 100. Maximum allowed value is 100.
ID Parameter: When id is provided, the API returns a single object.
Date Format: All date fields must be provided in ISO 8601 format: YYYY-MM-DDTHH:mm:ss.sssZ (e.g., \"2025-09-25T13:43:59.722Z\")
Date Range Requirement: Date range filters require both the \"From\" and \"To\" parameters to be provided together. If only one is provided, both will be ignored.
\nPagination: The limit parameter is capped at 100 records per request. Use offset to paginate through larger result sets.
This HTTP POST request is designed to send the task
\nPurpose of the Request:
The primary purpose of this request is to allow users to send the task.
Expected Input Parameters:
\nname: Name of the task.
\nformId: ID of the form.
\nlayout: Layout of the form.
\nassignedTaskTo: Specify the driverIds for whom the task is intended.
\nThis request is designed to deactivate a Form from the system. The entity object must include an id field to identify which form to deactivate.
Request Body Format:
\nThe request body must be sent as x-www-form-urlencoded.
The expected parameters include:
\nid (string): The unique identifier of the Form to be deleted.Response Structure:
\nThis method allows you to retrieve product information from the server. It can be used to return all products, a specific product, or a subset of products based on the provided input parameters.
\nThe request uses the x-www-form-urlencoded format and requires the following parameter:
method (required, string): `Get`
\ntypeName (required, string): `Product`
\nThe response will be in JSON format and will include the following structure:
\n{\n \"result\": [\n {\n \"id\": \"\",\n \"companyId\": \"\",\n \"name\": \"\",\n \"price\": 0,\n \"uniqueId\": \"\",\n \"zoneId\": \"\",\n \"createdDate\": \"\"\n }\n ]\n}\n\nresult: An array of product objects.
\nid: The unique identifier for the product.
\ncompanyId: The identifier for the company associated with the product.
\nname: The name of the product.
\nprice: The price of the product.
\nuniqueId: A unique identifier for the product.
\nzoneId: The zone identifier where the product is located.
\ncreatedDate: The date when the product was created.
\nThis method is versatile and can be adapted for various use cases involving product data retrieval.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"038055f5-1e2b-4310-a57e-c9c34a46c506","name":"Get Products","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Get\",\n \"params\": {\n \"typeName\": \"Product\",\n \"search\": {},\n \"credentials\": {\n \"sessionId\": \"sessionId\"\n }\n },\n \"type\": \"productType\"\n}","type":"text"}]},"url":"https://one-service.zenduit.com/api/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jun 2022 11:38:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"X-HTTP-Method-Override"},{"key":"etag","value":"W/\"bac-5JyeMWQo3rFLjDpYA4DmxFW7nQk\""},{"key":"via","value":"1.1 google"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=2QDSqE5kmkuTS7rSG%2BN2Y%2BowK8sOP6sCpO2D0MgBqAEbCLSpakZHKcfu5gIkPAnYws9cPC9%2BJjV4iNQxAEd4O9glnyvK%2B44D4FQrqec0d8hGhu6OM0U%2B3OCAI8eThvE6JfjJafEZqojR\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"722e60376e779b3f-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"id\": \"productId\",\n \"companyId\": \"companyId\",\n \"name\": \"name1\",\n \"price\": 123,\n \"uniqueId\": \"uniqueId1\",\n \"isArchived\": true,\n \"imageUrl\": \"imageUrl\",\n \"zoneId\": \"zoneId\",\n \"createdDate\": \"createdDate\"\n },\n {\n \"id\": \"productId\",\n \"companyId\": \"companyId\",\n \"name\": \"name2\",\n \"price\": 123,\n \"uniqueId\": \"uniqueId2\",\n \"isArchived\": true,\n \"zoneId\": \"83bf2fc0-cae1-11ec-9fe1-03cf0ab029d4\",\n \"createdDate\": \"createdDate\"\n }\n ]\n}"}],"_postman_id":"a70db9b2-0c95-47fa-baad-a12e952c90a5"},{"name":"Add Product","id":"a2b433ae-620c-46d8-886e-3ab5772a0386","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Add\",\n \"params\": {\n \"typeName\": \"Product\",\n \"entity\": {\n \"companyId\": \"companyId\",\n \"name\": \"name\",\n \"description\": \"description\",\n \"price\": 1,\n \"uniqueId\": \"uniqueId\",\n \"imageUrl\": \"imageUrl\",\n \"zoneId\": \"zoneId\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}","description":"This is an HTTP POST request to {{url}}. The purpose of this request is to add a new product to the system's database.
The request requires a payload with the x-www-form-urlencoded body type. The payload must include the following parameters:
JSON-RPC: This parameter is of type text and is used to specify the JSON-RPC protocol details.
typeName: The type of entity being added. This parameter indicates the category or classification of the product.
\nentity: The product entity itself, which contains all relevant details about the product being added.
\ncredentials: Authentication details required to authorize the request.
\nExpected Response Format:
The response will be in JSON format. A successful request will return a response with a status code of 200. An example of a possible response is as follows:
{\"result\":{\"id\":\"\"}}\n\nThis indicates that the request was processed successfully, and the id field will contain the unique identifier of the newly added product.
interface Product {\n id: string;\n companyId: string;\n name: string;\n description: string;\n price: number;\n uniqueId: string;\n imageUrl: string;\n zoneId: string;\n}\n\nThis request is used to modify an existing product in the database. The product to be modified is identified by its id, which must be provided in the request payload.
Request Parameters:
\nJSON-RPC: This is the main object for the request. It contains the following parameter:
\ntype: A string indicating the type of the request.Expected Input Structure:
\n{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"Product\",\n \"entity\": {\n \"companyId\": \"companyId\",\n \"name\": \"name\",\n \"description\": \"description\",\n \"price\": 1,\n \"uniqueId\": \"uniqueId\",\n \"imageUrl\": \"imageUrl\",\n \"zoneId\": \"zoneId\"\n },\n \"credentials\": {\n \"sessionId\": \"\"\n }\n },\n \"type\": \"\"\n}\n\nResponse Structure:
The response will typically be an empty JSON object {} indicating that the request was processed successfully. No additional data will be returned.
Product Interface:
The structure of a product in the database is defined as follows:
interface Product {\n id: string; // Unique identifier for the product\n companyId: string; // Identifier for the company associated with the product\n name: string; // Name of the product\n description: string; // Description of the product\n price: number; // Price of the product\n uniqueId: string; // Unique ID for the product\n imageUrl: string; // URL of the product image\n zoneId: string; // Identifier for the zone associated with the product\n}\n\nThis request is designed to permanently delete a specified Product object from the system. It is essential that the Product object includes an id field to identify which Product to remove.
Request Body Format:
The request body must be sent as x-www-form-urlencoded and should include the following parameter:
text and is used to specify the JSON-RPC protocol version and method being invoked.Example Request Body:
\n{\n \"method\": \"Delete\",\n \"params\": {\n \"typeName\": \"Product\",\n \"search\": {\n \"id\": \"id\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}\n\nExpected Response:
The response for this request will typically be an empty JSON object {}, indicating that the operation was successful and the Product has been removed.
Product Object Structure:
The following interface outlines the expected structure of the Product object:
interface ProductSearch {\n id?: string[] | string; // Unique identifier(s) for the Product\n companyId?: string; // Identifier for the associated company\n}\n\nEnsure that the id field is provided to successfully execute the delete operation.
search
\nentity
\nThis HTTP POST request is used to retrieve information about Location. It can return all Locations, a specific Location, or a subset of Locations based on the provided parameters.
\nRequest Body:
\nThe request uses the x-www-form-urlencoded format. The following parameters can be included in the request body:
id (optional, string): Search for an entry based on the specific ID of the Location. When provided with other filters, all filters are applied with AND logic.
\ngroups (optional, array of Ref): Search for Locations that are members of the specified Groups. Locations must match at least one of the provided groups.
\nsearchArea (optional, BoundingBox): A bounding box search for Location located within a specific area. The SearchArea object should include the minimum and maximum latitude and longitude to define the search area.
minimumRadiusInMeters (optional, number): Exclude Locations whose radius is smaller than this specified size in meters. Only applies to circular zones, polygon locations are returned as it is.
\nResponse Structure:
\nThe response will be a JSON object containing the result of the request. The structure of the response is as follows:
\n{\n \"result\": [\n {\n \"id\": \"\", // Unique identifier of the Location\n \"name\": null, // Name of the Location\n \"contactName\": null, // Contact person for the Zone\n \"contactEmail\": null, // Email of the contact person\n \"phone\": null, // Phone number of the contact person\n \"points\": [\n {\n \"x\": 0, // X coordinate of the Location\n \"y\": 0 // Y coordinate of the Location\n }\n ],\n \"displayed\": true, // Indicates if the Location is displayed\n \"openFrom\": {\n \"hour\": 0, // Opening hour of the Location\n \"minutes\": 0 // Opening minutes of the Location\n },\n \"openTo\": {\n \"hour\": 0, // Closing hour of the Location\n \"minutes\": 0 // Closing minutes of the Location\n }\n }\n ]\n}\n\nThis request is useful for applications that need to display or manage Locations based on specific criteria.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f5abac2c-5e81-483c-b4e3-22062868a2f5","name":"Get Zone","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Get\",\n \"params\": {\n \"typeName\": \"Zone\",\n \"search\": {\n \"groups\": [\n { \"id\": \"0e6dfbb0-27ca-11ee-a900-e5cffa6badc6\" },\n { \"id\": \"210142a0-2a13-11ee-af75-8df4b9f96740\" }\n ],\n \"minimumRadiusInMeters\": 35,\n \"searchArea\": {\n \"left\": -123.12,\n \"right\": -123.11,\n \"bottom\": 45.62,\n \"top\": 45.63\n }\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"https://one-service.zenduit.com/api/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jun 2022 12:27:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"X-HTTP-Method-Override"},{"key":"etag","value":"W/\"e90-pNK5KDsiIpcEUFq9t2xwpfgc7Qk\""},{"key":"via","value":"1.1 google"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=8rpRJLSh3jGwQWD7AP%2BvRL08o9awfgM%2Byj9Yn62YWm5f5ZeeME5iQlKZaGIAn6IUNB9MuzTMW0NaLA%2FxvYzJU1wzaXhN5%2F9%2BpZ8txRuPmYjQZhZ%2FULfad5hI1JnyMb2aK8zp9NHTgCEG\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"722ea8caccae6963-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"id\": \"id\",\n \"name\": null,\n \"contactName\": null,\n \"contactEmail\": null,\n \"phone\": null,\n \"points\": [\n {\n \"x\": 1,\n \"y\": 1\n }\n ],\n \"displayed\": true,\n \"openFrom\": {\n \"hour\": 18,\n \"minutes\": 30\n },\n \"openTo\": {\n \"hour\": 2,\n \"minutes\": 30\n }\n }\n ]\n}"}],"_postman_id":"10589d5d-5d24-4ff0-888d-5a80e86b17df"},{"name":"Add Location","id":"435bc2b8-3716-4e75-96ff-897d279c6d9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Add\",\n \"params\": {\n \"typeName\": \"Zone\",\n \"entity\": { },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}","description":"This HTTP POST request is used to create a new Location entity within the database. To successfully execute this request, you must provide the necessary credentials along with the following parameters:
\ntypeName: The type of entity being added. This parameter specifies the classification of the Location.
\nentity: The Location object containing the details of the new Location to be created.
\nThe request body should be formatted as x-www-form-urlencoded and must include the following parameters:
name (string): The name of the Location.
points (array of Point objects): An array representing the geographical points that define the Location.
groups (array of Ref objects, optional): A list of references to groups associated with the Location.
openFrom (object, optional): Specifies the opening time of the customer's works, containing:
hour (number): The hour of opening.
minutes (number): The minutes of opening.
openTo (object, optional): Specifies the closing time of the customer's works, containing:
hour (number): The hour of closing.
minutes (number): The minutes of closing.
contactName (string, optional): The name of the customer.
contactEmail (string, optional): The email address of the customer.
phone (string, optional): The phone number of the customer.
The response will typically include the details of the created Location, including its unique identifier (id) and any other relevant information that was set during the creation process.
Ensure that all required parameters are included in your request to avoid errors.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9ef49385-b7c9-42d5-83ed-d5925ac49979","name":"Add Zone","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Add\",\n \"params\": {\n \"typeName\": \"Zone\",\n \"entity\": {\n \"name\": \"Test-1\",\n \"points\": [\n { \"x\": 40.7129, \"y\": -74.0065 },\n { \"x\": 40.7129, \"y\": -74.0055 },\n { \"x\": 40.7121, \"y\": -74.0055 },\n { \"x\": 40.7121, \"y\": -74.0065 },\n { \"x\": 40.7129, \"y\": -74.0065 }\n ],\n \"openFrom\": {\n \"hour\": 14,\n \"minutes\": 15\n },\n \"openTo\": {\n \"hour\": 16,\n \"minutes\": 25\n },\n \"contactName\": \"Test T.\",\n \"contactEmail\": \"test@test.com\",\n \"phone\": \"+1 1234567\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"id\": \"b494da30-8d8b-11f0-a1de-61ddae07c4e4\"\n }\n}"}],"_postman_id":"435bc2b8-3716-4e75-96ff-897d279c6d9f"},{"name":"Update Location","id":"58d1af0d-f4da-4601-8f79-0ec8db8eab0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"Zone\",\n \"entity\": { },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}","description":"This endpoint allows you to modify a Location object in the database. The request must include the id of the Location object you wish to modify.
Request Parameters:
\nid (string, required): The unique identifier of the Location object to be modified.
name (string, required): The name of the Location.
activeTo (string, required): The date until which the Location is active.
activeFrom (string, required): The date from which the Location is active.
points (array of Point, required): An array of points defining the Location's geographical area.
zoneTypes (array of strings, required): An array of types associated with the Location.
displayed (boolean, optional): Indicates whether the Location should be displayed.
fillColor (Color, optional): The color used to fill the Location.
groups (array of Ref, optional): An array of references to associated groups.
openFrom (object, optional): An object representing the opening time with hour and minutes.
openTo (object, optional): An object representing the closing time with hour and minutes.
contactName (string, optional): The name of the customer associated with the Location.
contactEmail (string, optional): The email of the customer associated with the Location.
phone (string, optional): The phone number of the customer associated with the Location.
Expected Response:
A successful response will return the modified Location object with updated details. Ensure to handle any errors appropriately, which may arise if the id is not found or if required fields are missing.
Notes:
\nMake sure to provide valid data types for each parameter.
\nThe id is mandatory and must be specified to modify an existing Location.
Request Method: POST
Endpoint: {{url}}
Request Body:
The request body should be sent as x-www-form-urlencoded with the following parameters:
id (optional, string): Search for an entry based on the specific Id.
\ngroups (optional, array of Ref): Search for Locations that are members of these GroupSearch(es), one of its children, or one of its parents.
\nsearchArea (optional, BoundingBox): The BoundingBox search for Locations in this area extent. The Locations being retrieved must be located in this area, typically used for retrieving Locations in the extents of a bounding box. The SearchArea object should contain the minimum and maximum latitude and longitude representing the search area.
\nminimumRadiusInMeters (optional, number): Exclude Locations whose radius is smaller than this size (in meters).
\nExpected Response Format:
The response will typically include a confirmation of the deletion and may contain additional information about the status of the operation.
search
\nentity
\nThis method can be used to retrieve user data. It supports various queries to return all users, a single user, or a specific set of users based on the provided parameters.
\nRequest Parameters:
\nThe request uses the x-www-form-urlencoded body type, and the following parameters can be included:
name (string, optional): The name of the user to search for.
id (string, optional): The unique identifier of the user.
groups: The groups filter
mapProvider: Search by the map service linked to the data (e.g., Google, Here).
language: The language filter
customField[] : filter for custom fields
security: Filter based on permission level (User or Admin)
Response Structure:
\nThe response will be in JSON format and includes an array of user objects with the following structure:
\n{\n \"result\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phoneNumber\": \"string\",\n \"type\": \"string\",\n \"isMetric\": true\n }\n ]\n}\n\nid: The unique identifier for the user.
name: The name of the user.
email: The email address of the user.
firstName: The first name of the user.
lastName: The last name of the user.
phoneNumber: The phone number of the user.
type: The type of user.
isMetric: A boolean indicating if the user can assign jobs to themselves.
This request is used to create a new user entity. In addition to the credentials, the method requires a minimum of two parameters: the type of entity being added (typeName) and the entity itself.
Expected Input Parameters:
\ntypeName: The type of entity being added (e.g., \"user\", \"admin\", \"notification\").
User: An object containing user details with the following properties:
name (string): The name of the user.
email (string, optional): The email address of the user.
firstName (string, optional): The first name of the user.
lastName (string, optional): The last name of the user.
type (string, optional): The type of user, which can be \"user\", \"admin\", or \"notification\".
phoneNumber (string, optional): The phone number of the user.
canAssignJobItself (boolean, optional): Indicates if the user can assign jobs to themselves.
password (string, optional): The password for the user account.
isDriver (boolean, optional): Indicates if the user is a driver.
Response Structure:
The response will contain a result object with the following properties:
Id: The unique identifier of the newly created user.
Password: The password associated with the user account.
Example Response:
\n{\n \"result\": {\n \"Id\": \"\",\n \"Password\": \"\"\n }\n}\n\nThis API request is designed to modify an existing user object in the database. To successfully execute this request, the user ID or the name must be included in the payload.
\nThe purpose of this request is to update the details of a user, allowing for modifications to various user attributes as needed.
\nThe request body should be sent using the x-www-form-urlencoded format. The following parameters can be included:
name (string): The full name of the user.
id (string): Id of the user.
email (string, optional): The email address of the user.
firstName (string, optional): The user's first name.
lastName (string, optional): The user's last name.
type (string, optional): The role of the user, which can be either \"user\", \"admin\", or \"notification\".
phoneNumber (string, optional): The user's phone number.
callAssignJobItself (boolean, optional): Indicates if the user can assign jobs to themselves.
isDriver (boolean, optional): Indicates if the user is a driver.
\nid takes precidence over name while mapping user. Only one of the two are required to update a user.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"47df5fd5-18fa-4add-836b-aa51936885da","name":"Update User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"User\",\n \"entity\": {\n \"name\": \"johndoe@gofleet.com\",\n \"id\": \"5f195150-3c38-11e8-9506-99672472486f\",\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+1234567890\",\n \"type\": \"admin\",\n \"canAssignJobItself\": true,\n \"isDriver\": false,\n \"isCheckIn\": false\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jun 2022 07:34:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"X-HTTP-Method-Override"},{"key":"etag","value":"W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\""},{"key":"via","value":"1.1 google"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=Ag%2B34DiZSA4ZqMpAk4NtkNd65%2Fg0WqSwZcwh1TiHgtx5ZwALEB1TedtGnUy5FeiHoXXYkk0qms8q1R2cMGK8uQ51AFs%2FiMwAk%2Fs8ga%2Bqqjsegjy7FK8T2N71nQVVvYni2YhmHoXwOTIO\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"722cfa691d6c9bf8-FRA"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"23619982-ac22-429f-91fd-fcdffea946ee"},{"name":"Delete User","id":"14e57cf2-d87b-40df-8b83-290568bba6e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Delete\",\n \"params\": {\n \"typeName\": \"User\",\n \"search\": {\n \"name\": \"PublicAPITest\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}","description":"This request is designed to permanently delete a user and all related data from the system. It is crucial to ensure that the user to be deleted is identified correctly, as this action cannot be undone.
\nPurpose:
\nThe purpose of this API endpoint is to facilitate the permanent removal of a user and their associated data from the database. This action is irreversible, and it is essential to verify the user details before executing the request.
\nRequest Body Format:
\nThe request must include the following parameter in the x-www-form-urlencoded format:
\nname (string): The name of the user to be deleted. This field is mandatory.Expected Response:
\nResponse Structure:
\n{\n \"status\": \"success\",\n \"message\": \"User deleted successfully.\"\n}\n\nMake sure to provide the correct user name to avoid unintended data loss.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3b6e5232-8b72-4117-b836-c4b2e004a626","name":"Delete User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Delete\",\n \"params\": {\n \"typeName\": \"User\",\n \"search\": {\n \"name\": \"PublicAPITest\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Jun 2022 07:36:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"X-HTTP-Method-Override"},{"key":"etag","value":"W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\""},{"key":"via","value":"1.1 google"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=v6x05lqPlcdu%2BLYXrkk6o69qyVJ2EnrdXIypoxILncZEwjGrgD58IjHEWZ8SgTnlQGeyzxUFTFdj1CJksgjTqxVIE60kTa5HQeBjmGRIGTK%2B5UPIx4NORQjauaRBQdN6U%2BJmLkOLpGgt\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"722cfdcd09709bf8-FRA"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"14e57cf2-d87b-40df-8b83-290568bba6e1"},{"name":"Reset Password","id":"1398b980-d008-4f38-a569-e1f22899d639","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"User\",\n \"entity\": {\n \"name\": \"clintonelvie@gofleet.com\",\n \"id\": \"5f195150-3c38-11e8-9506-99672472486f\",\n \"password\": \"newHashedPasswordHere\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}","description":"Used to update password of a user. The updated password should be already hashed.
\nThe request body should be sent using the x-www-form-urlencoded format. The following parameters can be included:
name (string): The full name of the user.
id (string): Id of the user.
password (string): Hashed password.
id takes precidence over name while mapping user. Only one of the two are required to update a user.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4be3e210-f191-415b-a148-a119c85c40c2","name":"Reset Password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Set\",\n \"params\": {\n \"typeName\": \"User\",\n \"entity\": {\n \"name\": \"John Doe\",\n \"id\": \"5f195150-3c38-11e8-9506-99672472486f\",\n \"password\": \"newHashedPasswordHere\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"1398b980-d008-4f38-a569-e1f22899d639"}],"id":"4c344e25-42ea-4e4b-a0e2-c4691c04428b","description":"This method can be used in various ways to return all, one, or some specific set of data for the Groups.
\nRequest Body Format:
The request body should be formatted as x-www-form-urlencoded. The following parameters can be included:
includeAllTrees (text, optional): Include Groups from all trees, for example, \"Security Groups\" and \"Private User Groups\". The \"Company Group\" tree is included by default.
name (text, optional): Search for Groups with this Name. Wildcard can be used by prepending/appending \"%\" to the string. Example: \"%name%\".
id (text, optional): Search for an entry based on the specific Id.
Expected Response Format:
The response will be a JSON object containing a result array. Each object in the array represents a group and may include the following fields:
id: The unique identifier of the group.
name: The name of the group.
children: An array of child groups, each with its own id.
Example response:
\n{\n \"result\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"children\": [\n {\n \"id\": \"\"\n }\n ]\n }\n ]\n}\n\nThis HTTP POST request is designed to create a new Group entity within the database. To successfully execute this request, it is essential to provide a minimum of two parameters: typeName (indicating the type of entity being added) and the entity itself, which adheres to the defined structure of a Group.
Expected Input Parameters:
\ntypeName: A string that specifies the type of entity being added.
name: A string representing the unique name of the group.
children: An optional array that can hold a list of child Group(s).
Group Structure:
\ninterface Group {\n id?: string; // The unique identifier for this entity.\n name: string; // The name of this entity that uniquely identifies it.\n parent: { id: string; }; // The parent Group of the selected group.\n color?: Color; // The Color used to render assets belonging to this group. Default [Blue].\n comments?: string; // Free text field for user information. Default [\"\"].\n children?: Array; // The Children of this group. A list of Group(s).\n}\n\nResponse:
The response will typically include details about the newly created group, including its unique identifier and any default values that were assigned during creation.
This endpoint allows you to modify an existing group in the database. The group must be identified by its unique ID, which needs to be provided in the request.
\nRequest Parameters (x-www-form-urlencoded):
\nid (string, required): The unique identifier for the group you wish to modify.
name (string, required): The name of the group that uniquely identifies it and is used for display purposes.
children (array, optional): A list of child groups associated with this group.
Notes:
\nid parameter is correctly populated to avoid errors.This HTTP POST request is designed to permanently delete a specified Group and all its related data from the system.
\nRequest Body Format:
\nThe request body should be sent as x-www-form-urlencoded.
The following parameters can be included in the request body:
\nid (string, required): The unique identifier of the Group that you wish to remove. This field is mandatory for the request to be processed.Response Structure:
\nOn a successful deletion, the response will typically include a confirmation message indicating that the Group has been removed successfully.
\nIn case of an error (e.g., if the Group ID does not exist), the response will contain an error message detailing the issue.
\nEnsure that you have the necessary permissions to perform this operation, as it will irreversibly delete the specified Group and all its associated data.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"13fd5e27-8181-4dd0-a8c1-8a9295375673","name":"Delete Groups","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Delete\",\n \"params\": {\n \"typeName\": \"Group\",\n \"search\": { },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"c87c4ea6-4db5-489b-9787-9b0b8e30e7d1"}],"id":"f99d85b7-602f-45db-adb9-5df299297118","description":"This method can be used in various ways to return all, one, or a specific set of data for the Exceptions.
\nPurpose:
The request is designed to search for exceptions based on specified criteria.
Expected Input Parameters:
The request body should be formatted as x-www-form-urlencoded with the following parameters:
deviceSearch: Optional object - Device search criteria containing:
\nid: Optional string - Unique identifier of the device
name: Optional string - Name of the device
groups: Optional Ref array - Array of group references associated with the device
ruleSearch: Optional object - Rule search criteria containing:
\nid: Optional string - Unique identifier of the rule
name: Optional string - Name of the rule
driver: Optional object - Driver information for filtering exceptions containing:
\nid: Optional string - Unique identifier of the driver
name: Optional string - Name of the driver
fromDate: Optional string - Start date for the search time range (ISO string format)
\ntoDate: Optional string - End date for the search time range (ISO string format)
\nspeed: Optional object - Speed range filter for exceptions containing:
\nmin: Optional number - Minimum speed value
max: Optional number - Maximum speed value
location: Optional object - Location information for filtering exceptions containing:
\nid: Optional string - Unique identifier of the location
name: Optional string - Name of the location
tag: Optional object - Tag information for filtering exceptions containing:
\nid: Optional string - Unique identifier of the tag
name: Optional string - Name of the tag
/**\n * Interface for searching and filtering exceptions in the system.\n * Provides various search criteria to find specific exceptions based on\n * device, rule, driver, time range, speed, location, and tag parameters.\n */\nexport interface ExceptionSearch {\n /** Device search criteria */\n deviceSearch?: {\n /** Unique identifier of the device */\n id?: string;\n /** Name of the device */\n name?: string;\n /** Array of group references associated with the device */\n groups?: Array;\n };\n /** Rule search criteria */\n ruleSearch?: {\n /** Unique identifier of the rule */\n id?: string;\n /** Name of the rule */\n name?: string;\n };\n /** Driver information for filtering exceptions */\n driver?: {\n /** Unique identifier of the driver */\n id?: string;\n /** Name of the driver */\n name?: string;\n };\n /** Start date for the search time range (ISO string format) */\n fromDate?: string;\n /** End date for the search time range (ISO string format) */\n toDate?: string;\n /** Speed range filter for exceptions */\n speed?: { \n /** Minimum speed value */\n min?: number, \n /** Maximum speed value */\n max?: number \n };\n /** Location information for filtering exceptions */\n location?: {\n /** Unique identifier of the location */\n id?: string;\n /** Name of the location */\n name?: string;\n };\n /** Tag information for filtering exceptions */\n tag?: {\n /** Unique identifier of the tag */\n id?: string;\n /** Name of the tag */\n name?: string;\n };\n}\n\nResponse Structure:
The response will typically include a list of exceptions that match the search criteria, with details pertaining to each exception. The exact structure of the response will depend on the specific implementation and may include fields such as exception ID, message, timestamp, and associated device information.
This method can be used to return all, one, or a specific set of data for the GPS Logs. It allows users to search for GPS log records based on specific criteria.
\nPurpose:
The primary purpose of this request is to retrieve GPS log records associated with devices, allowing for filtering based on date ranges.
Expected Input Parameters:
The request body is expected to be in x-www-form-urlencoded format and may include the following parameters:
deviceSearch (optional): A reference to the device for which the GPS logs are being searched.
fromDate (optional): A string representing the start date for the range of logs to be retrieved.
toDate (optional): A string representing the end date for the range of logs to be retrieved.
Structure of the Response:
The response will include a collection of GPS log records that match the specified search criteria. Each log record will typically contain information such as timestamp, location coordinates, and device identifiers.
interface LogRecordSearch {\n deviceSearch?: Ref;\n // Range for due date\n fromDate?: string;\n // Range for due date\n toDate?: string;\n}\n\nThis API endpoint allows you to retrieve Custom Map records from the server. It is designed to facilitate the management and access of map-related data within your application.
\nRequest Format:
\nMethod: POST
\nContent-Type: application/x-www-form-urlencoded
\nExpected Request Body:
The request body should be formatted as key-value pairs in the x-www-form-urlencoded format. Each key represents a specific parameter required for the request, and the values should be provided accordingly. The specific parameters required for this request are not detailed in the current documentation, so please ensure to include any necessary parameters relevant to your use case.
Response Structure:
The response will contain the details of the Custom Map records. The structure of the response will typically include:
A status code indicating the success (200) or failure of the request.
\nA JSON object containing the following fields:
\nresult: An array of objects representing the retrieved Custom Map records, where each object includes:
\nid: The unique identifier for the map record.
\nname: The name of the map.
\nurl: The URL associated with the map.
\nimageWidth: The width of the map image.
\nimageHeight: The height of the map image.
\nrotation: The rotation angle of the map.
\nscale: The scale factor of the map.
\nlocation: An object containing:
\nlat: Latitude of the map location.
\nlng: Longitude of the map location.
\ndevices: An array of device objects associated with the map, where each device includes:
\nid: The unique identifier for the device.
\nleft: The left position of the device.
\ntop: The top position of the device.
\nEnsure that you provide the necessary parameters in the request body to successfully retrieve the desired records.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"96506b57-6b1a-4ab2-bf8b-64c782aa8c69","name":"Get Custom Maps","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Get\",\n \"params\": {\n \"typeName\": \"CustomMap\",\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"7817"},{"key":"ETag","value":"W/\"1e89-xlbldayqgSwK1w/JucR9Rk3Tp0c\""},{"key":"Date","value":"Fri, 18 Jul 2025 20:02:39 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"result\": [\n {\n \"id\": \"id\",\n \"name\": \"name\",\n \"url\": \"url\",\n \"imageWidth\": \"imageWidth\",\n \"ImageHeight\": \"ImageHeight\",\n \"rotation\": \"rotation\",\n \"scale\": \"scale\",\n \"location\": {\n \"lat\": \"lat\",\n \"lng\": \"lng\"\n },\n \"devices\": [\n {\n \"id\": \"id\",\n \"left\": \"left\",\n \"top\": \"top\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"ea0d9608-7c3e-47ac-9d7c-e5204b4e3e81"}],"id":"0ab43c27-3f1d-4fc6-ae0c-927a0a96ec7a","_postman_id":"0ab43c27-3f1d-4fc6-ae0c-927a0a96ec7a","description":""},{"name":"Geoconding","item":[{"name":"GetAddresses","id":"8c4c3eb8-199d-4e06-b08b-bdb7373ac9b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"GetAddresses\",\n \"params\": {\n \"coordinates\": [\n {\n \"x\":-79.7239949406194,\n \"y\":43.51197251474255\n }\n ],\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"068c7390-9409-4c73-aec4-e4d51b5dfe9c","name":"GetAddresses","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"GetAddresses\",\n \"params\": {\n \"coordinates\": [\n {\n \"x\":-79.7239949406194,\n \"y\":43.51197251474255\n }\n ],\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n}","type":"text"}]},"url":"{{url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"X-HTTP-Method-Override"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"59"},{"key":"ETag","value":"W/\"3b-AtcDaUO7aQ0uACYF5deLoFct6e8\""},{"key":"Date","value":"Fri, 18 Jul 2025 20:24:38 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"result\": [\n {\n \"formattedAddress\": \"formattedAddress\"\n }\n ]\n}"}],"_postman_id":"8c4c3eb8-199d-4e06-b08b-bdb7373ac9b7"}],"id":"d5d0a699-65ed-4dad-8441-045da825e564","_postman_id":"d5d0a699-65ed-4dad-8441-045da825e564","description":""},{"name":"POI","item":[{"name":"Get POI","id":"1590b59d-3886-4174-8d2e-eff77f549f88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Get\",\n \"params\": {\n \"typeName\": \"POI\",\n \"search\": { },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"publicmap\"\n }","type":"text"}]},"url":"{{url}}","description":"This endpoint retrieves Points of Interest (POI) from the system using JSON-RPC format.
It requires valid authentication via sessionId
The purpose of this request is to retrieve Points of Interest (POIs) with their details such as name, location, description, and icon.
\nThe response from this endpoint will typically include a status code indicating the success or failure of the operation, along with any relevant data. The structure of the response will generally follow a consistent format that includes:
\nStatus: Indicates the success (200) or failure of the request.
\nContent-Type: The type of content returned, which is typically application/json.
Result: An array of POIs, each containing:
\nname (string): The name of the POI.
description (string): The description of the POI.
icon (string): The URL of the POI icon.
lat (number): The latitude of the POI.
lng (number): The longitude of the POI.
This method retrieves trip information and can be utilized to return all trips, a single trip, or a specific set of trips based on the provided parameters.
\nRequest Body Format:
\nThe request should be sent using the x-www-form-urlencoded format. The body may include the following parameters:
Response Structure:
The response will be in JSON format and contains the following structure:
{\n \"result\": [\n {\n \"id\": \"\", // Unique identifier for the trip\n \"device\": {\n \"id\": \"\" // Unique identifier for the device associated with the trip\n },\n \"distance\": 0, // Distance covered in the trip\n \"driver\": null, // Driver information (if available)\n \"start\": \"\", // Start time of the trip\n \"stop\": \"\", // End time of the trip\n \"stopDuration\": \"\", // Duration of stops during the trip\n \"drivingDuration\": \"\" // Duration of driving\n }\n ]\n}\n\nThis method can be used to return all rules.
\nPurpose:
The purpose of this request is to retrieve a list of rules from the server.
Request Format:
\nMethod: POST
\nContent-Type: application/x-www-form-urlencoded
\nRequest Body: The request body should be sent in the x-www-form-urlencoded format. Currently, no parameters are specified for the request body.
\nResponse Structure:
The response will be in JSON format and will include the following structure:
{\n \"result\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}\n\nresult: An array of rule objects.
\nid: A unique identifier for the rule.
\nname: The name of the rule.
\nThis method can be used to return links for live streaming. The format of live streaming depends on the camera provider.
\nRequest Body Format:
\nThe request should be sent with the x-www-form-urlencoded content type.
The expected parameters in the request body are as follows:
\ndeviceSearch (optional): A reference to the device ID for which live stream links are being requested.Response Structure:
\nThe response will contain the links to the live streams based on the provided device ID. The exact structure of the response may vary depending on the camera provider but typically includes:
\nStream URLs
\nMetadata about the streams (e.g., quality, type)
\ninterface LiveStreamSearch {\n // device id\n deviceSearch?: Ref;\n}\n\nThis POST request is designed to fetch the historical media streams associated with a specific device over a defined time range. The request allows users to specify the device and the time interval for which the historical data is required.
\nRequest Body Format:
The request body should be sent as x-www-form-urlencoded and must include the following parameters:
device (optional): A reference identifier for the device whose historical stream is being requested.
\nfromDate (optional): A string representing the start of the time range for the request, formatted in a suitable date-time format.
\ntoDate (optional): A string representing the end of the time range for the request, also formatted in a suitable date-time format.
\nResponse Structure:
Upon a successful request, the method will return a list of media streams that fall within the specified time range. Please note that the time range limit for the request is 10 minutes.
interface RequestOptions {\n // Device id\n device?: Ref;\n // Start of range for request\n fromDate?: string;\n // End of range for request\n toDate?: string;\n}\n\nThis endpoint allows you to retrieve media recordings by specifying the necessary parameters in the request body.
\nRequest Body Parameters:
\nJSON-RPC (type: text): This parameter is used to define the JSON-RPC protocol version and method for the request.Request Options:
\ninterface RequestOptions {\n // Device id\n device?: Ref; // Optional: The unique identifier for the device from which recordings are requested.\n // Start of range for request\n fromDate?: string; // Optional: The start date for the range of recordings to retrieve, formatted as a string.\n // End of range for request\n toDate?: string; // Optional: The end date for the range of recordings to retrieve, formatted as a string.\n}\n\nExpected Response:
The response will contain the media recordings that match the specified criteria, including details such as recording IDs, timestamps, and any other relevant metadata.
Notes:
\nEnsure that the device parameter is correctly specified to retrieve recordings for the intended device.
The date parameters (fromDate and toDate) should be formatted correctly to avoid errors in the request.
This request is designed to wake up a specified device by sending an HTTP POST request.
\nRequest Parameters:
\ndevice (optional): The identifier for the device that needs to be woken up. This should be a reference to the specific device.Expected Response:
\nNotes:
\nEnsure that the device ID provided is valid and corresponds to an existing device in the system.
\nThis operation may require appropriate permissions or authentication to execute successfully.
\nThis method can be used to fetch media content for a specific device. It allows you to initiate a video request by providing a range of dates for the media content you want to retrieve.
\nExpected Input Parameters:
\ntype (string, required): The type of media request. This should be set to \"video\".
device (Ref, optional): The identifier for the device from which you want to fetch the media content.
fromDate (string, optional): The start date of the range for the video request in ISO 8601 format.
toDate (string, optional): The end date of the range for the video request in ISO 8601 format.
Response Structure:
\nThe method returns a task id which can be used to track the status of the request. You can check the status of the task using the method Task Status.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"02475433-1885-4093-8077-999e9068bb77","name":"Video Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Execute\",\n \"params\": {\n \"typeName\": \"Media\",\n \"actionName\": \"Request\",\n \"arguments\": {\n \"type\": \"video\",\n \"device\": { \"id\": \"{{deviceId}}\" },\n \"fromDate\": \"2022-11-14T00:00:00.000Z\",\n \"toDate\": \"2022-11-14T00:00:20.000Z\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"id\": \"1d7f4ad0-6431-11ed-a94d-91b2582c870c\"\n }\n}"}],"_postman_id":"f2b7645c-1981-4f2c-b6e1-79a9212c1c71"},{"name":"Snapshot Request","event":[{"listen":"test","script":{"id":"65108cc0-4d47-4828-a397-0b133e975b3f","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"taskId\", data.result.id)"],"type":"text/javascript","packages":{}}}],"id":"8e3ec317-be79-4a7e-88ed-2a5e8e0aafe9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Execute\",\n \"params\": {\n \"typeName\": \"Media\",\n \"actionName\": \"Request\",\n \"arguments\": {\n \"type\": \"snapshots\",\n \"device\": { \"id\": \"{{deviceId}}\" },\n \"fromDate\": \"2022-11-14T00:00:00.000Z\",\n \"toDate\": \"2022-11-14T00:00:20.000Z\",\n \"snapshotsInterval\": 60000\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"{{productType}}\"\n }","type":"text"}]},"url":"{{url}}","description":"This method can be used to fetch media content for a specific device.
\nHTTP Method: POST
Endpoint: {{url}}
Request Body:
The request uses the x-www-form-urlencoded format. The following parameters can be included in the request:
type (string): Specifies the request type. Must be set to \"snapshots\".
device (string, optional): The ID of the device for which media content is requested.
\nfromDate (string, optional): The start date for the range of video requests.
\ntoDate (string, optional): The end date for the range of video requests.
\nResponse Format:
The method returns a task id. You can check the status of the task using the method Task Status.
This method can be used to check the status and retrieve the result for a media request. It allows clients to query the status of a specific task identified by its unique task ID.
\nRequest Parameters:
\ntask (optional): A reference to the unique identifier of the task whose status is being queried.Expected Input:
\nThe request should be sent as an x-www-form-urlencoded payload. The only parameter required is task, which should be a string representing the task ID.
Response Structure:
\nThe response will typically include the status of the task and any relevant results associated with it. The exact structure of the response may vary based on the task's state.
\ninterface TaskStatusResponse {\n // status of the task (e.g., pending, completed, failed)\n status: string;\n // additional details about the task result\n result?: any;\n}\n\nThis HTTP POST request is used to retrieve custom data based on specified search criteria. The request allows users to filter the results by providing relevant field names.
\nExpected Input Parameters:
\nThe request body should be formatted as x-www-form-urlencoded with the following parameters:
CUSTOM_FIELD_NAME_1 (text, optional): A field name used to filter the custom data.
\nCUSTOM_FIELD_NAME_2 (text, optional): Another field name used to further refine the search for custom data.
\nResponse Structure:
\nUpon a successful request, the response will return a JSON object containing an array of results. Each result will have the following structure:
\n{\n \"result\": [\n {\n \"_id\": \"\", // Unique identifier for the custom data entry\n \"name\": \"\", // Name associated with the custom data entry\n \"zenduOneCustomerId\": \"\" // Identifier linking to the customer in the ZenduOne system\n }\n ]\n}\n\nThis endpoint is versatile and can be used to return all, one, or a specific set of custom data entries based on the provided search criteria.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"068912c3-b45a-4fce-8722-8e1de8fd5cb9","name":"Get Custom Entities","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Get\",\n \"params\": {\n \"typeName\": \"CustomData\",\n \"search\": {},\n \"offset\": 0,\n \"limit\": 100,\n \"entityType\": \"my_custom_type\",\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"zenduone\"\n}","type":"text"}]},"url":"{{url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 12:28:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"X-HTTP-Method-Override"},{"key":"etag","value":"W/\"5010-LaGbGCG5HBfhDCTbP/C8K5gkPJ8\""},{"key":"via","value":"1.1 google"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=mjstiDJlK%2BGngKAm8f%2FO5yhZaidrju72yzCug4OPnIFkro2KaDcc7AZQ67PV9JPssQT7UkmBuirFJN5eaciq%2BqCUwTF5SZbWmUV1HW3yQemgL%2BvCggmnRJFNYiHJ5ZXsKMaMfZrRMnuN\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7205766f1f02bbce-FRA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"_id\": \"650d4da55412955a085111a2\",\n \"name\": \"Entity Name\",\n \"zenduOneCustomerId\": \"609be11221da8325b81f4b5d\",\n \"unique_id\": \"unique_id\"\n }\n ]\n}"}],"_postman_id":"11a35afe-a123-42b1-93d0-64121c0338a6"},{"name":"Add Entity","id":"d88f492c-314f-4802-aade-c3dd1028352f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"JSON-RPC","value":"{\n \"method\": \"Add\",\n \"params\": {\n \"typeName\": \"CustomData\",\n \"entity\": {\n \"name\": \"Entity Name\"\n },\n \"entityType\": \"my_custom_type\",\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"zenduone\"\n}","type":"text"}]},"url":"{{url}}","description":"This HTTP POST request is designed to add a new custom entity to the database. It requires specific parameters to successfully create the entity.
\nExpected Input Parameters:
\ntypeName: The type of entity that is being added. This parameter is essential for categorizing the entity correctly.
Additional parameters can be included as needed for your integration. Each parameter should correspond to the fields defined in the entity structure.
\nEntity Structure:
The entity should adhere to the following structure, where each field is a string:
interface Entity {\n CUSTOM_FIELD_NAME_1: string; // Description of CUSTOM_FIELD_NAME_1\n CUSTOM_FIELD_NAME_2: string; // Description of CUSTOM_FIELD_NAME_2\n CUSTOM_FIELD_NAME_3: string; // Description of CUSTOM_FIELD_NAME_3\n}\n\nResponse Structure:
Upon a successful request, the API will return a response in the following format:
{\n \"result\": {\n \"id\": \"\" // The unique identifier for the newly created entity\n }\n}\n\nThis response includes the id of the newly created entity, which can be used for further operations or references.
This API endpoint allows you to modify a custom entity stored in the database. The request must include the _id of the entity that you wish to update.
\nThe primary purpose of this request is to update the properties of a specific custom entity identified by its unique identifier.
\nThe request body should be formatted as x-www-form-urlencoded and must include the following parameters:
_id: (string) The unique identifier of the custom entity to be modified.
\nCUSTOM_FIELD_NAME_1: (string) The value for the first custom field of the entity.
\nCUSTOM_FIELD_NAME_2: (string) The value for the second custom field of the entity.
\nCUSTOM_FIELD_NAME_3: (string) The value for the third custom field of the entity.
\nUpon a successful request, the response will return a JSON object with the following structure:
\n{\n \"result\": {}\n}\n\nThe result object will contain the updated information of the custom entity, though the specific fields returned will depend on the implementation.
This request is used to perform an upsert operation on a custom entity within the database. An upsert operation will either update an existing entity if it exists or create a new entity if it does not.
\nRequest Format:
\nMethod: POST
\nContent-Type: application/x-www-form-urlencoded
\nThe request body should include the following parameters:
\n_id (string): The unique identifier for the entity.
\nCUSTOM_FIELD_NAME_1 (string): The first custom field associated with the entity.
\nCUSTOM_FIELD_NAME_2 (string): The second custom field associated with the entity.
\nCUSTOM_FIELD_NAME_3 (string): The third custom field associated with the entity.
\nResponse Structure:
The response will return a JSON object indicating the result of the upsert operation. The structure of the response is as follows:
{\n \"result\": {}\n}\n\nThe result object may contain additional information depending on the outcome of the operation.
This request is a POST request to the specified endpoint {{url}}. The purpose of this request is to permanently remove a Custom Entity.
Request Parameters:
\nExpected Response:
\n{ \"result\": {}}
\nThe response contains a result object, which may hold additional information regarding the outcome of the request.
Note: The Entity object must include an _id field as part of the request to identify the specific entity to be removed.
interface EntitySearch {\n _id: string;\n}\n\nsearch
\nentity
\nentityType
\nThis API allows you to upload a file to cloud storage.
\nRequest Method: POST
Endpoint: {{url}}/file/upload
Request Parameters:
\nfile (type: text): The file to be uploaded.Expected Response:
The API returns a URL pointing to the uploaded cloud file.
This request is used to retrieve various types of trackers available in the system. It allows users to obtain information about different tracker types that can be utilized for tracking purposes.
\nRequest Format:
\nMethod: POST
\nContent-Type: application/x-www-form-urlencoded
\nExpected Request Body:
\nResponse Structure:
The response will be in JSON format and will contain the following structure:
{\n \"result\": [\n {\n \"name\": \"string\", // Name of the tracker type\n \"description\": \"string\", // Description of the tracker type\n \"deviceCategory\": \"string\", // Category of the device associated with the tracker\n \"portalLink\": \"string\" // Link to the portal for more information\n }\n ]\n}\n\nEach object in the result array represents a different tracker type, providing essential details for each.
This endpoint allows you to retrieve comments associated with a specific parent entity. It is useful for fetching comments based on various filtering criteria.
\nRequest Body Format:
The request body should be sent as x-www-form-urlencoded and includes the following parameters:
parentId (required): The ID of the parent entity for which comments are being retrieved. This can be a single string or an array of strings.
\ndateFrom (optional): The start date for filtering comments. It can be a string or a Date object.
\ndateTo (optional): The end date for filtering comments. It can be a string or a Date object.
\nlimit (optional): The maximum number of comments to return. It should be a number.
\noffset (optional): The number of comments to skip before starting to collect the result set. It should be a number.
\nResponse Structure:
The response will typically include a list of comments that match the specified criteria. Each comment object will contain relevant details such as the comment text, author, and timestamps.
Make sure to provide the necessary parameters in the request body to ensure accurate results.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa04d985-20fd-40a8-87be-d83b8a095c42"}],"id":"2ae37b09-2cfb-4154-949b-4a8a94528d8c","description":"Input Properties:
\nid: Optional string - Unique identifier for the maintenance request (auto-generated if not provided)
\ncompanyId: String - ID of the company that owns this maintenance request
\nstatus: MaintenanceStatus - Current status of the maintenance request (e.g., pending, in-progress, completed)
\nstatusChangeDate: Date - Date when the status was last changed
\nsource: String - Origin/source of the maintenance request (e.g., 'manual', 'automated', 'inspection')
\ncreatedBy: String - ID or name of the user who created this request
\ncreatedDate: Date - Date and time when the request was created
\norderNumber: Optional number - Sequential order number for tracking purposes
\norderId: Optional string - Reference to a related order ID
\nresolutionDate: Optional Date - Date when the maintenance was completed/resolved
\nserviceProvider: Optional string - Name or ID of the service provider handling the maintenance
\nserviceNumber: Optional number - Service provider's internal service number/reference
\nloggedTime: Optional number - Total time logged for this maintenance request (in hours/minutes)
\naddedToRepair: Optional boolean - Flag indicating if this request was added to a repair order
\nresolvedBy: Optional string - ID or name of the user who resolved the request
\nassignTo: Optional string - ID or name of the user currently assigned to handle this request
\nassignedBy: Optional string - ID or name of the user who made the assignment
\nassignDate: Optional Date - Date when the request was assigned
\ntags: Optional string array - Tags for categorization and filtering
\nodometer: Optional number - Vehicle/equipment odometer reading at request creation
\nresolvedOdometer: Optional number - Vehicle/equipment odometer reading at resolution
\nengineHours: Optional number - Engine hours at request creation
\nresolvedEngineHours: Optional number - Engine hours at resolution
\nruleId: Optional string - ID of the maintenance rule that triggered this request (for automated requests)
\ncancellationReason: Optional string - Reason provided if the request was cancelled
\ndetails: Object - Core maintenance request details containing:
\nasset: String - ID or name of the asset requiring maintenance
maintenanceType: String - Type of maintenance (e.g., 'preventive', 'corrective', 'emergency')
reference: String - Reference number or code for this maintenance type
dueDate: Date - Scheduled due date for the maintenance
summary: String - Brief description or summary of the maintenance work needed
priority: MaintenancePriority - Priority level of the maintenance request
addedProducts: ServiceRequestProduct array - Products/parts added to this service request
\ntotalCost: Optional number - Total cost of the maintenance request (parts + service + labour). Generated on backend for API filtering/sorting
\npartsCost: Optional number - Total cost of parts/products used. Generated on backend for API filtering/sorting
\nserviceCost: Optional number - Total service fees. Generated on backend for API filtering/sorting
\nlabourCost: Optional number - Total labour costs. Generated on backend for API filtering/sorting
\nproductLabours: String - Concatenated string of product labour descriptions for search/filtering. Generated on backend for API filtering/sorting
\nExpected Input Structure:
\n/**\n * Represents a maintenance service request for company assets/equipment.\n * This interface tracks the complete lifecycle of maintenance requests from creation to resolution.\n */\ninterface MaintenanceServiceRequest {\n /** Unique identifier for the maintenance request (auto-generated if not provided) */\n id?: string;\n /** ID of the company that owns this maintenance request */\n companyId: string;\n /** Current status of the maintenance request (e.g., pending, in-progress, completed) */\n status: MaintenanceStatus;\n /** Date when the status was last changed */\n statusChangeDate: Date;\n /** Origin/source of the maintenance request (e.g., 'manual', 'automated', 'inspection') */\n source: string;\n /** ID or name of the user who created this request */\n createdBy: string;\n /** Date and time when the request was created */\n createdDate: Date;\n /** Optional sequential order number for tracking purposes */\n orderNumber?: number;\n /** Optional reference to a related order ID */\n orderId?: string;\n /** Date when the maintenance was completed/resolved */\n resolutionDate?: Date;\n /** Name or ID of the service provider handling the maintenance */\n serviceProvider?: string;\n /** Service provider's internal service number/reference */\n serviceNumber?: number;\n /** Total time logged for this maintenance request (in hours/minutes) */\n loggedTime?: number;\n /** Flag indicating if this request was added to a repair order */\n addedToRepair?: boolean;\n /** ID or name of the user who resolved the request */\n resolvedBy?: string;\n /** ID or name of the user currently assigned to handle this request */\n assignTo?: string;\n /** ID or name of the user who made the assignment */\n assignedBy?: string;\n /** Date when the request was assigned */\n assignDate?: Date;\n /** Optional array of tags for categorization and filtering */\n tags?: string[];\n /** Vehicle/equipment odometer reading at request creation */\n odometer?: number;\n /** Vehicle/equipment odometer reading at resolution */\n resolvedOdometer?: number;\n /** Engine hours at request creation */\n engineHours?: number;\n /** Engine hours at resolution */\n resolvedEngineHours?: number;\n /** ID of the maintenance rule that triggered this request (for automated requests) */\n ruleId?: string;\n /** Reason provided if the request was cancelled */\n cancellationReason?: string;\n /** Core maintenance request details */\n details: {\n /** ID or name of the asset requiring maintenance */\n asset: string;\n /** Type of maintenance (e.g., 'preventive', 'corrective', 'emergency') */\n maintenanceType: string;\n /** Reference number or code for this maintenance type */\n reference: string;\n /** Scheduled due date for the maintenance */\n dueDate: Date;\n /** Brief description or summary of the maintenance work needed */\n summary: string;\n /** Priority level of the maintenance request */\n priority: MaintenancePriority;\n };\n /** Array of products/parts added to this service request */\n addedProducts: ServiceRequestProduct[];\n /**\n * Cost breakdown fields - automatically calculated on the backend\n * These props are generated on the backend and are used for table API filtering/sorting\n */\n /** Total cost of the maintenance request (parts + service + labour) */\n totalCost?: number;\n /** Total cost of parts/products used */\n partsCost?: number;\n /** Total service fees */\n serviceCost?: number;\n /** Total labour costs */\n labourCost?: number;\n /** Concatenated string of product labour descriptions for search/filtering */\n productLabours: string;\n}\n\nInput Properties:
\nid: String - Unique identifier for the repair order
\ncompanyId: String - ID of the company that owns this repair order
\norderNumber: Number - Sequential order number for tracking and reference purposes
\ncreatedBy: String - ID or name of the user who created this repair order
\ncreatedDate: Date - Date and time when the repair order was created
\nresolvedBy: Optional string - ID or name of the user who resolved/completed the repair order
\nresolutionDate: Optional Date - Date when the repair order was completed/resolved
\ndetails: Object - Core repair order details containing:
\nasset: String - ID or name of the asset requiring repair
priority: MaintenancePriority - Priority level of the repair order
assignTo: String - ID or name of the user assigned to handle this repair order
serviceProvider: Optional string - Name or ID of the service provider handling the repair
summary: Optional string - Brief description or summary of the repair work needed
dueDate: Date - Scheduled due date for the repair completion
reference: Optional string - Reference number or code for this repair type
addedServices: String array - List of services added to this repair order
\nsummary: OrderSummary - Summary information and totals for the repair order
\nstatus: MaintenanceStatus - Current status of the repair order (e.g., pending, in-progress, completed)
\nstatusChangeDate: Date - Date when the status was last changed
\nassignedBy: String - ID or name of the user who made the assignment
\nassignDate: Date - Date when the repair order was assigned
\ncancellationReason: Optional string - Reason provided if the repair order was cancelled
\nproductLabours: Object array - Product labour information generated on backend for API filtering/sorting. Each object contains:
\nid: String - Unique identifier for the product labour
name: String - Name or description of the product labour
serviceRequests: Number array - Array of service request IDs associated with this repair order. Generated on backend for API filtering/sorting
\nExpected Input Structure:
\nexport interface RepairOrder {\n /** Unique identifier for the repair order */\n id: string;\n /** ID of the company that owns this repair order */\n companyId: string;\n /** Sequential order number for tracking and reference purposes */\n orderNumber: number;\n /** ID or name of the user who created this repair order */\n createdBy: string;\n /** Date and time when the repair order was created */\n createdDate: Date;\n /** ID or name of the user who resolved/completed the repair order */\n resolvedBy?: string;\n /** Date when the repair order was completed/resolved */\n resolutionDate?: Date;\n /** Core repair order details */\n details: {\n /** ID or name of the asset requiring repair */\n asset: string;\n /** Priority level of the repair order */\n priority: MaintenancePriority;\n /** ID or name of the user assigned to handle this repair order */\n assignTo: string;\n /** Name or ID of the service provider handling the repair */\n serviceProvider?: string;\n /** Brief description or summary of the repair work needed */\n summary?: string;\n /** Scheduled due date for the repair completion */\n dueDate: Date;\n /** Reference number or code for this repair type */\n reference?: string;\n };\n /** List of services added to this repair order */\n addedServices: string[];\n /** Summary information and totals for the repair order */\n summary: OrderSummary;\n /** Current status of the repair order (e.g., pending, in-progress, completed) */\n status: MaintenanceStatus;\n /** Date when the status was last changed */\n statusChangeDate: Date;\n /** ID or name of the user who made the assignment */\n assignedBy: string;\n /** Date when the repair order was assigned */\n assignDate: Date;\n /** Reason provided if the repair order was cancelled */\n cancellationReason?: string;\n /**\n * These props are generated on the backend and are used for table API filtering/sorting\n */\n /** Product labour information with ID and name for each item */\n productLabours: {\n /** Unique identifier for the product labour */\n id: string,\n /** Name or description of the product labour */\n name: string\n }[];\n /** Array of service request IDs associated with this repair order */\n serviceRequests: number[];\n}\n\nThis request is used to update the status of an existing request in the system. The request to be updated is identified by its id, and the new status value is provided to change the current state of the request.
Request Parameters:
\nid: String - Unique identifier for the request that needs to be updated
\nstatus: String - New status value to be applied to the request (e.g., \"Pending\", \"In Progress\", \"Completed\", \"Cancelled\")
\nExpected Input Structure:
\n{\n // Unique identifier for the request\n \"id\": \"request_id\",\n // Current status of the request (e.g., \"Pending\", \"In Progress\", \"Completed\", \"Cancelled\")\n \"status\": \"Completed\"\n}\n\nInput Properties:
\nid: String - Unique identifier for the repair order
\ncompanyId: String - ID of the company that owns this repair order
\norderNumber: Number - Sequential order number for tracking and reference purposes
\ncreatedBy: String - ID or name of the user who created this repair order
\ncreatedDate: Date - Date and time when the repair order was created
\nresolvedBy: Optional string - ID or name of the user who resolved/completed the repair order
\nresolutionDate: Optional Date - Date when the repair order was completed/resolved
\ndetails: Object - Core repair order details containing:
\nasset: String - ID or name of the asset requiring repair
priority: MaintenancePriority - Priority level of the repair order
assignTo: String - ID or name of the user assigned to handle this repair order
serviceProvider: Optional string - Name or ID of the service provider handling the repair
summary: Optional string - Brief description or summary of the repair work needed
dueDate: Date - Scheduled due date for the repair completion
reference: Optional string - Reference number or code for this repair type
addedServices: String array - List of services added to this repair order
\nsummary: OrderSummary - Summary information and totals for the repair order
\nstatus: MaintenanceStatus - Current status of the repair order (e.g., pending, in-progress, completed)
\nstatusChangeDate: Date - Date when the status was last changed
\nassignedBy: String - ID or name of the user who made the assignment
\nassignDate: Date - Date when the repair order was assigned
\ncancellationReason: Optional string - Reason provided if the repair order was cancelled
\nproductLabours: Object array - Product labour information generated on backend for API filtering/sorting. Each object contains:
\nid: String - Unique identifier for the product labour
name: String - Name or description of the product labour
serviceRequests: Number array - Array of service request IDs associated with this repair order. Generated on backend for API filtering/sorting
\nExpected Input Structure:
\nexport interface RepairOrder {\n /** Unique identifier for the repair order */\n id: string;\n /** ID of the company that owns this repair order */\n companyId: string;\n /** Sequential order number for tracking and reference purposes */\n orderNumber: number;\n /** ID or name of the user who created this repair order */\n createdBy: string;\n /** Date and time when the repair order was created */\n createdDate: Date;\n /** ID or name of the user who resolved/completed the repair order */\n resolvedBy?: string;\n /** Date when the repair order was completed/resolved */\n resolutionDate?: Date;\n /** Core repair order details */\n details: {\n /** ID or name of the asset requiring repair */\n asset: string;\n /** Priority level of the repair order */\n priority: MaintenancePriority;\n /** ID or name of the user assigned to handle this repair order */\n assignTo: string;\n /** Name or ID of the service provider handling the repair */\n serviceProvider?: string;\n /** Brief description or summary of the repair work needed */\n summary?: string;\n /** Scheduled due date for the repair completion */\n dueDate: Date;\n /** Reference number or code for this repair type */\n reference?: string;\n };\n /** List of services added to this repair order */\n addedServices: string[];\n /** Summary information and totals for the repair order */\n summary: OrderSummary;\n /** Current status of the repair order (e.g., pending, in-progress, completed) */\n status: MaintenanceStatus;\n /** Date when the status was last changed */\n statusChangeDate: Date;\n /** ID or name of the user who made the assignment */\n assignedBy: string;\n /** Date when the repair order was assigned */\n assignDate: Date;\n /** Reason provided if the repair order was cancelled */\n cancellationReason?: string;\n /**\n * These props are generated on the backend and are used for table API filtering/sorting\n */\n /** Product labour information with ID and name for each item */\n productLabours: {\n /** Unique identifier for the product labour */\n id: string,\n /** Name or description of the product labour */\n name: string\n }[];\n /** Array of service request IDs associated with this repair order */\n serviceRequests: number[];\n}\n\nInput Properties:
\nid: String - Unique identifier for the repair order
\ncompanyId: String - ID of the company that owns this repair order
\norderNumber: Number - Sequential order number for tracking and reference purposes
\ncreatedBy: String - ID or name of the user who created this repair order
\ncreatedDate: Date - Date and time when the repair order was created
\nresolvedBy: Optional string - ID or name of the user who resolved/completed the repair order
\nresolutionDate: Optional Date - Date when the repair order was completed/resolved
\ndetails: Object - Core repair order details containing:
\nasset: String - ID or name of the asset requiring repair
priority: MaintenancePriority - Priority level of the repair order
assignTo: String - ID or name of the user assigned to handle this repair order
serviceProvider: Optional string - Name or ID of the service provider handling the repair
summary: Optional string - Brief description or summary of the repair work needed
dueDate: Date - Scheduled due date for the repair completion
reference: Optional string - Reference number or code for this repair type
addedServices: String array - List of services added to this repair order
\nsummary: OrderSummary - Summary information and totals for the repair order
\nstatus: MaintenanceStatus - Current status of the repair order (e.g., pending, in-progress, completed)
\nstatusChangeDate: Date - Date when the status was last changed
\nassignedBy: String - ID or name of the user who made the assignment
\nassignDate: Date - Date when the repair order was assigned
\ncancellationReason: Optional string - Reason provided if the repair order was cancelled
\nproductLabours: Object array - Product labour information generated on backend for API filtering/sorting. Each object contains:
\nid: String - Unique identifier for the product labour
name: String - Name or description of the product labour
serviceRequests: Number array - Array of service request IDs associated with this repair order. Generated on backend for API filtering/sorting
\nExpected Input Structure:
\nexport interface RepairOrder {\n /** Unique identifier for the repair order */\n id: string;\n /** ID of the company that owns this repair order */\n companyId: string;\n /** Sequential order number for tracking and reference purposes */\n orderNumber: number;\n /** ID or name of the user who created this repair order */\n createdBy: string;\n /** Date and time when the repair order was created */\n createdDate: Date;\n /** ID or name of the user who resolved/completed the repair order */\n resolvedBy?: string;\n /** Date when the repair order was completed/resolved */\n resolutionDate?: Date;\n /** Core repair order details */\n details: {\n /** ID or name of the asset requiring repair */\n asset: string;\n /** Priority level of the repair order */\n priority: MaintenancePriority;\n /** ID or name of the user assigned to handle this repair order */\n assignTo: string;\n /** Name or ID of the service provider handling the repair */\n serviceProvider?: string;\n /** Brief description or summary of the repair work needed */\n summary?: string;\n /** Scheduled due date for the repair completion */\n dueDate: Date;\n /** Reference number or code for this repair type */\n reference?: string;\n };\n /** List of services added to this repair order */\n addedServices: string[];\n /** Summary information and totals for the repair order */\n summary: OrderSummary;\n /** Current status of the repair order (e.g., pending, in-progress, completed) */\n status: MaintenanceStatus;\n /** Date when the status was last changed */\n statusChangeDate: Date;\n /** ID or name of the user who made the assignment */\n assignedBy: string;\n /** Date when the repair order was assigned */\n assignDate: Date;\n /** Reason provided if the repair order was cancelled */\n cancellationReason?: string;\n /**\n * These props are generated on the backend and are used for table API filtering/sorting\n */\n /** Product labour information with ID and name for each item */\n productLabours: {\n /** Unique identifier for the product labour */\n id: string,\n /** Name or description of the product labour */\n name: string\n }[];\n /** Array of service request IDs associated with this repair order */\n serviceRequests: number[];\n}\n\nThis request is used to update the status of an existing order in the system. The request to be updated is identified by its id, and the new status value is provided to change the current state of the request.
Request Parameters:
\nid: String - Unique identifier for the request that needs to be updated
\nstatus: String - New status value to be applied
\nExpected Input Structure:
\n{\n // Unique identifier for the order\n \"id\": \"request_id\",\n // The new status\n \"status\": \"Completed\"\n}\n\nsearch
\npayload
\nThis HTTP POST request is used to send audio message to cameras. Currently, the messaged support English and Spanish.
\nSupported only on specific Zenduit Camera devices.
\nExpected Input Parameters:
\nThe request uses the x-www-form-urlencoded format. The following parameters can be included in the request body:
deviceId: List of the Ids of the Streammax devices the message has to be sent to.
\nlanguage: Langusge of the message. ('english', 'spanish')
\ntext: Text of the message.
\nNote: There is a limit of 150 characters for the text message.
\nResponse Structure:
\nThe response will be a JSON object containing the result of the request. The structure of the success response is as follows:
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"359b5e3d-0ba0-4262-85d2-ded8e63ad862","name":"Send message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"JSON-RPC","value":"{\n \"method\": \"Execute\",\n \"params\": {\n \"typeName\": \"TextToSpeech\",\n \"entity\": {\n \"text\": \"Hello! How you doing?\",\n \"deviceId\": [\"66eabc70-9a8d-11ee-b2eb-013684cfc9f4\"],\n \"language\": \"english\"\n },\n \"credentials\": {\n \"sessionId\": \"{{sessionId}}\"\n }\n },\n \"type\": \"trax\"\n }"}]},"url":"https://one-service.zenduit.com/api/v1"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"result\": {\n \"success\": true\n }\n}"}],"_postman_id":"08179391-100c-40fa-870f-8472bc771959"}],"id":"1de00ee6-17e6-445e-999e-16240e071f97","_postman_id":"1de00ee6-17e6-445e-999e-16240e071f97","description":""},{"name":"Two Way Communication","item":[],"id":"841560a6-da66-404d-84c1-2911ee2d57ad","description":"A simple, structured wrapper for two-way communication functionality built on top of the H5 Player. This library provides a clean, modern API for integrating intercom capabilities into your applications.
\n<script src=\"twc.js\"></script>\n\n// Initialize with your auth session ID\nconst intercom = new TwoWayComm('your-auth-sessionId');\n// Set up event listeners\nintercom.on('ready', () => console.log('Ready to make calls!'));\nintercom.on('callStarted', (data) => console.log(`Call started with ${data.deviceId}`));\nintercom.on('callStopped', () => console.log('Call ended'));\nintercom.on('error', (error) => console.error('Error:', error));\n// Initialize the client\nawait intercom.initialize();\n// Start a call\nawait intercom.startCall('your-device-id', 'en');\n// Stop the call when done\nintercom.stopCall();\n\nSession Id: Required for initialization
\nDevice ID: Required to start calls
\nModern Browser: Supports ES6+ features (async/await, classes)
\nH5 Player: Automatically loaded from /h5-player/h5-player.js
const intercom = new TwoWayComm(authToken)\n\nParameters: - authToken (string, required): Your authentication sessionId
async initialize()Initializes the client and loads necessary resources.
\nawait intercom.initialize();\n\nReturns: Promise that resolves when initialization is complete
\nThrows: Error if initialization fails
\nasync startCall(deviceId, language?)Starts an intercom call with the specified device.
\nawait intercom.startCall('device-123', 'en');\n\nParameters: - deviceId (string, required): Target device identifier - language (string, optional): Language code (defaults to 'en')
Supported Languages: en, es, fr, pt, cn
Returns: Promise that resolves when call starts
\nThrows: Error if call fails to start
\nstopCall()Stops the current active call.
\nintercom.stopCall();\n\nreset()Resets the client to initial state, stopping any active calls.
\nintercom.reset();\n\n// Check current state\nintercom.getState() // Returns current state string\nintercom.isReady() // Returns true if ready to start calls\nintercom.isCallActive() // Returns true if call is active\n// Get current call info\nintercom.getCurrentCall() // Returns { deviceId, language, isActive }\n\nThe library uses an event-driven architecture. Subscribe to events using the on() method:
intercom.on('eventName', (data) => {\n // Handle event\n});\n\n// Subscribe to events\nintercom.on('ready', callback);\n// Unsubscribe from events\nintercom.off('ready', callback);\n// Method chaining supported\nintercom\n .on('ready', () => console.log('Ready!'))\n .on('error', (err) => console.error('Error:', err));\n\nThe client maintains internal states for proper operation:
\nuninitialized - Initial state
initializing - Loading resources
ready - Ready to start calls
starting_call - Call is being established
call_active - Call is active
stopping_call - Call is being terminated
error - Error state
The library uses hardcoded, optimized settings:
\nThese settings are configured internally and cannot be modified.
\nThe library provides comprehensive error handling with detailed context:
\nintercom.on('error', (errorData) => {\n console.log('Error Type:', errorData.type);\n console.log('Error Details:', errorData.error);\n switch (errorData.type) {\n case 'initialization':\n // Handle initialization errors\n break;\n case 'call_start':\n console.log('Failed device:', errorData.deviceId);\n break;\n case 'intercom':\n // Handle H5Player errors\n break;\n }\n});\n\nError Types: - initialization - Failed to initialize client - call_start - Failed to start call - call_stop - Failed to stop call - intercom - H5Player internal errors - intercom_start - H5Player failed to start
<html>\n<head>\n <title>TwoWayComm Example</title>\n</head>\n<body>\n <button id=\"initBtn\">Initialize</button>\n <button id=\"startBtn\" disabled>Start Call</button>\n <button id=\"stopBtn\" disabled>Stop Call</button>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' id=\"status\">Ready to initialize</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' id=\"log\"></div>\n <script src=\"twc.js\"></script>\n <script>\n let intercom = null;\n let initialized = false;\n let callActive = false;\n const statusEl = document.getElementById('status');\n const logEl = document.getElementById('log');\n function log(message) {\n const entry = document.createElement('div');\n entry.textContent = `${new Date().toLocaleTimeString()}: ${message}`;\n logEl.appendChild(entry);\n }\n function updateButtons() {\n document.getElementById('initBtn').disabled = initialized;\n document.getElementById('startBtn').disabled = !initialized || callActive;\n document.getElementById('stopBtn').disabled = !callActive;\n }\n // Initialize client\n document.getElementById('initBtn').addEventListener('click', async () => {\n try {\n intercom = new TwoWayComm('your-sessionId-here');\n // Set up event listeners\n intercom.on('initialized', () => {\n log('Client initialized');\n });\n intercom.on('ready', () => {\n log('Client ready');\n initialized = true;\n updateButtons();\n statusEl.textContent = 'Ready to start calls';\n });\n intercom.on('callStarted', (data) => {\n log(`Call started: ${data.deviceId}`);\n callActive = true;\n updateButtons();\n statusEl.textContent = 'Call active';\n });\n intercom.on('callStopped', () => {\n log('Call stopped');\n callActive = false;\n updateButtons();\n statusEl.textContent = 'Call ended';\n });\n intercom.on('error', (error) => {\n log(`Error: ${error.type} - ${JSON.stringify(error.error)}`);\n statusEl.textContent = `Error: ${error.type}`;\n });\n statusEl.textContent = 'Initializing...';\n await intercom.initialize();\n } catch (error) {\n log(`Initialization failed: ${error.message}`);\n statusEl.textContent = 'Initialization failed';\n }\n });\n // Start call\n document.getElementById('startBtn').addEventListener('click', async () => {\n if (!intercom) return;\n try {\n statusEl.textContent = 'Starting call...';\n await intercom.startCall('your-device-id', 'en');\n } catch (error) {\n log(`Failed to start call: ${error.message}`);\n statusEl.textContent = 'Failed to start call';\n }\n });\n // Stop call\n document.getElementById('stopBtn').addEventListener('click', () => {\n if (!intercom) return;\n statusEl.textContent = 'Stopping call...';\n intercom.stopCall();\n });\n // Initialize UI\n updateButtons();\n </script>\n</body>\n</html>\n\nA complete test interface is available at test.html. It demonstrates all functionality and provides detailed logging for debugging.
To test:
\n1. Start a local server: python3 -m http.server 8080
2. Open http://localhost:8080/test.html
3. Enter your Session Id and device ID
\n4. Test the complete workflow
\n\"Session Id is required\" Error - Ensure you pass a valid session Id to the constructor
\n\"Cannot initialize from state: X\" Error - Call reset() to return to initial state before reinitializing
\"Cannot start call from state: X\" Error - Ensure client is initialized and ready before starting calls - Check that no other call is active
\n\"Device ID is required\" Error - Provide a valid device ID when calling startCall()
H5Player Loading Issues - Ensure /h5-player/h5-player.js is accessible - Check browser console for script loading errors - Verify server is serving static files correctly
This library provides a clean, modern interface for two-way communication while handling all the complexity of the underlying H5Player internally.
\nConnect with Support to access the library.
\n","_postman_id":"841560a6-da66-404d-84c1-2911ee2d57ad"}],"variable":[{"key":"appname","value":"","type":"default"}]}