instantCMR API documentation

The Custom Menu API allows developers to create and manage a personalized interface for drivers, enhancing their experience with tailored functionalities. This API is structured around two main components: the Custom Menu (Scren) and Widgets (Mbut). The Custom Menu serves as the container for various widgets, each performing specific actions or displaying pertinent information.

By using this API, developers can craft a user-friendly and functional interface that streamlines a driver's daily operations, improving both efficiency and usability.

GET scren

Downloads the custom menu of a user if present.

Request

GET /v3/igr/user/{copid}/{userxtid}/scren HTTP/1.1  
Host: api.instantcmr.com  
x-icmr-auth-1: {authentication-token}

copid	Company identifier assigned by instantCMR
userxtid	Client-generated user identifier
authentication-token	See Authentication.

Response

HTTP/1.1 200 OK  
Date: Thu, 23 Jan 2020 16:29:47 GMT  
Content-Type: application/json; charset=UTF-8  
ETag: {ETag}
Content-Length: 1386  

{scren}

Response codes

200 OK	Request was successful. Response contains the custom menu entity in the response body and its entity version tag in the ETag response header.
401 Unauthorized	Missing or invalid authentication-token.
403 Forbidden	Authenticated user does not have sufficient permission to access users of company designated by copid.
404 Not Found	User with id of userxtid not found or the user does not have a custom menu.
429 Too Many Requests	Request has been throttled as user exceeded API quota.

Response headers

ETag	string	Entity version tag. Must be supplied in subsequent PUT scren requests in the If-Match header.

Response body

scren	scren	Custom menu response entity.

PUT scren

Stores a custom menu of the user specified by userxtid, optionally updating the previous custom menu of the user if present.

Request

PUT /v3/igr/user/{copid}/{userxtid}/scren HTTP/1.1  
Host: api.instantcmr.com  
[If-Match: {ETag}]  
[If-None-Match: *]  
x-icmr-auth-1: {authentication-token}  

{scren}

copid	Company identifier assigned by instantCMR
userxtid	Client-generated user identifier
ETag	Entity version tag. Provide previous custom menu entity version tag when updating an already existing custom menu entity. When creating a new entity pass *‘’ in the If-None-Match** header.
authentication-token	See Authentication.

Response

HTTP/1.1 200 OK  
Date: Thu, 23 Jan 2020 16:29:47 GMT  
Content-Type: application/json; charset=UTF-8  
ETag: {ETag}
Content-Length: 1386  

{scren}

Response codes

200 OK	Request was successful. Response contains the updated custom menu entity in the response body and its updated entity version tag in the ETag response header.
401 Unauthorized	Missing or invalid authentication-token.
403 Forbidden	Authenticated user does not have sufficient permission to access users of company designated by copid.
404 Not Found	User with id of userxtid not found or the user does not have a custom menu and an If-Match header was sent.
412 PreconditionFailed	ETag specified in If-Match or If-None-Match headers did not match the current custom menu entity version. Retrieve the current custom menu entity using GET scren, reapply the changes, and retry the PUT scren request with updated ETag.
429 Too Many Requests	Request has been throttled as user exceeded API quota.

Response headers

ETag	string	Entity version tag. Must be supplied in subsequent PUT scren requests in the If-Match header.

Response body

scren	scren	Custom menu response entity.

DELETE scren

Removes the custom menu of the user specified by userxtid.

Request

DELETE /v3/igr/user/{copid}/{userxtid}/scren HTTP/1.1  
Host: api.instantcmr.com  
[If-Match: {ETag}]  
[If-None-Match: *]  
x-icmr-auth-1: {authentication-token}

copid	Company identifier assigned by instantCMR
userxtid	Client-generated user identifier
ETag	Entity version tag. Provide previous custom menu entity version tag when updating an already existing custom menu entity.
authentication-token	See Authentication.

Response

HTTP/1.1 200 OK  
Date: Thu, 23 Jan 2020 16:29:47 GMT

Response codes

200 OK	Request was successful. Response contains the updated custom menu entity in the response body and its updated entity version tag in the ETag response header.
401 Unauthorized	Missing or invalid authentication-token.
403 Forbidden	Authenticated user does not have sufficient permission to access users of company designated by copid.
404 Not Found	User with id of userxtid not found or the user does not have a custom menu and an If-Match header was sent.
412 PreconditionFailed	ETag specified in If-Match or If-None-Match headers did not match the current custom menu entity version. Retrieve the current custom menu entity using GET scren and retry the DELETE scren request with updated ETag.
429 Too Many Requests	Request has been throttled as user exceeded API quota.