movizon CONTROL REST API
1 / 11Pages

movizon CONTROL REST API Version 2022-10-27 moi/izonmovizon CONTROL REST APIBase URL Scheme Each REST API request is assigned to a registered user, which must authenticate itself using HTTP basic authentication. The credentials are transmitted as Base64 encoded string in the form [USERNAME]:[PASSWORD] inside the authorization header. If authentication fails, error code 401 is returned. Each REST API request requires permission. If permission is not granted, error code 403 is returned. This happens in one of the following cases: The administrator settings for the requesting user does not allow resource access in combination with the requested CRUD operation. The result of the requested operation would exceed the responsibility limit for this resource type set for the requesting user by the administrator. For example, if a user is allowed to be responsible for up to 10 jobs, this user won’t be able to create an 11th job - but deletion requests would be granted. The user requests a modification or deletion of a resource that is locked by another user. The user requests an operation that is forbidden by the system, e.g. the modification of a read-only resource or resource property. Several request types are available to perform standard CRUD (Create, Read, Update, Delete) operations on mC’s resources:

movizon CONTROL REST API Version 2022-10-27

movizon CONTROL REST API Version 2022-10-27

movizon CONTROL REST API Version 2022-10-27 Batch Service In order to minimize the overhead generated by HTTP requests, several individual requests can be combined into a single request. The following table shows the details: Scheme Request method Request path Request body [{ "method": [METHOD_1], "path": [RELATIVE_PATH_1], "body": [BODY_1] }, { "method": [METHOD_2], "path": [RELATIVE_PATH_2], "body": [BODY_2] }, { "method": [METHOD_N], "path": [RELATIVE_PATH_N], "body": [BODY_N] }] Response code Response body [{ "method": "DELETE", "path": "waypoints/77", "body": "" }, { "method": "PUT",...

movizon CONTROL REST API Version 2022-10-27 Subscription Service mC's REST server can only react to requests. For clients who want to be automatically informed about changes to certain resources - e.g. vehicle movement or job progress and completion - a subscription service via WebSocket is available. To subscribe please follow these steps: 1. Subscribe to the desired resources via REST API request Method: POST; Path: [BASE_URL]/subscription; Body: [RT1, RT2, ...] mC creates the authentication token required for step 2 and transmits this in the location header of the response 2. Open a...

movizon CONTROL REST API Version 2022-10-27 Common Resource Fields Resources in mC v4 are structured like maps that can have any number of key-value-pairs. Despite this flexibility, logical modules must agree on a common understanding of the properties of each resource type. Each module / script setup can have its own key system, but many fields are constant for most setups. These common fields are described in the table below: Usage Example Value mandatory system fields for all resource types ID of the resource; can't be changed time of creation in milliseconds since January 1, 1970 UTC...

movizon CONTROL REST API Version 2022-10-27

movizon CONTROL REST API Version 2022-10-27

movizon CONTROL REST API Version 2022-10-27

movizon CONTROL REST API Version 2022-10-27

movizon CONTROL REST API Version 2022-10-27