Document Storage API

Enumerates the contents of a document storage assigned to a user identified by userxtid .

GET /v3/igr/dbox/{copid}/{userxtid}/fil[?expire={download-url-expiry}] HTTP/1.1  
Host: api.instantcmr.com  
x-icmr-auth-1: {authentication-token}  

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

{dboxed}

Upload a document to a user’s document storage

Documents are identified by their path and file name within the document storage (file-path). Document and folder names within the path may not start or end with a whitespace character and must be concatenated with forward slash (/) characters. The file-path must not end with a forward slash (/) character.

As a result of this request, all folders on the specified file-path will be automatically created if they do not exist.

Uploading a document with the same file-path as an already existing document will replace the previous document with the uploaded one.

Documents uploaded to a user’s document storage will be delivered to the user’s mobile device as soon as network conditions permit. Drivers can click the document to open it with an external app registered for the mime type of the document.

When the document has been successfully delivered to the user, a document storage item delivery receipt is created in the user’s document storage.

PUT /v3/igr/dbox/{copid}/{userxtid}/fil/{file-path} HTTP/1.1  
Host: api.instantcmr.com  
x-icmr-auth-1: {authentication-token}  
Content-Type: application/octet-stream  
Accept: */*  
Content-Length: 11741  

{document-bytes}  

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

Create a folder in a user’s document storage area.

Folders are identified by their path and name within the document storage (folder-path). Folder names within the path may not start or end with a whitespace character and must be concatenated with forward slash (/) characters. The folder-path must end with a forward slash (/) character.

As a result of this request, all folders on the specified folder-path will be automatically created if they do not exist.

Creating a folder with the same folder-path as an already existing folder will result in a no-operation and return a 200 OK response..

Folders created in a user’s document storage will be delivered to the user’s mobile device as soon as network conditions permit. When the folder has been successfully delivered to the user, a document storage item delivery receipt is created in the user’s document storage.

PUT /v3/igr/dbox/{copid}/{userxtid}/fil/{folder-path}/ HTTP/1.1  
Host: api.instantcmr.com  
x-icmr-auth-1: {authentication-token}  
Accept: */*  

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

Removes a document or folder from a user’s document storage.

Removes a document or folder specified by folder-or-file-path from the document storage of the user specified by userxtid.

When deleting a folder, folder-or-file-path must end with a trailing forward slash (/) character. All documents and folders contained within the target folder will be automatically removed from the document storage.

When deleting a document, folder-or-file-path must not end with a trailing forward slash (/) character.

As a result of this request the document or folder (including its entire contents) will be removed from the user’s mobile device. When this succeeds all document storage item delivery receipts corresponding to documents and folders removed from the user’s mobile device will be also deleted from the user’s document storage. Please note however that until this happens, the document storage might contain document storage item delivery receipts referring to documents and/or folders that are not anymore stored in the document storage.

DELETE /v3/igr/dbox/{copid}/{userxtid}/fil/{folder-or-file-path} HTTP/1.1  
Host: api.instantcmr.com  
x-icmr-auth-1: {authentication-token}  
Content-Type: application/octet-stream  
Accept: */*  

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

Moves or renames a document or folder within a user’s document storage.

Moves or renames a document or folder specified by source-folder-or-file-path within the document storage of the user specified by source-userxtid.

The new location of the document or folder should be specified in the request body using a Document move target entity, specifying the target-userxtid and target-folder-or-file-path. The current version of the Document Storage API only supports moving documents or folders within a single document storage, hence source-userxtid and target-userxtid must match.

To rename a document or folder, specify the same path using a different name in source-folder-or-file-path and target-folder-or-file-path.

When moving a folder, both source-folder-or-file-path and target-folder-or-file-path must end with a trailing forward slash (/) character. All documents and folders contained within the target folder will be automatically moved along with the source folder within the document storage.

When moving a document, both source-folder-or-file-path and target-folder-or-file-path must not end with a trailing forward slash (/) character.

As a result of this request the source document or folder (including its entire contents) will be moved on the user’s mobile device without the device re-downloading the document or folder contents.

PUT /v3/igr/dbox/{copid}/{source-userxtid}/mv/{source-folder-or-file-path} HTTP/1.1  
Host: api.instantcmr.com  
x-icmr-auth-1: {authentication-token}  
Content-Type: application/octet-stream  
Accept: */*  

{filta}

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

Downloads a document from a user’s document storage.

GET {document-url-path} HTTP/1.1  
Host: {document-url-host}  
x-icmr-auth-1: {authentication-token}  

HTTP/1.1 200 Thank you  
Content-Length: 67676  
Content-Type: image/jpeg  
Etag: "16049243cba368ad9bea03033d6f2fb6"  
Last-Modified: Thu, 23 Nov 2017 21:14:23 GMT  

{document-bytes}