Automated Package Dimensioner
API Integration

vMeasure-API_integration

Get Latest Measurement

The REST API call to this endpoint returns the response containing the measurement data of the latest measurement performed in the vMeasure system.

Request:

Endpoint: http://<'IP address of the vison box'>:6600 /api/dimension
Example: http://192.168.7.1:6600/api/dimension/
Http Method: GET

Response:

				
					{
    "id": "461",   
    "scannedOn": "Fri Nov 26, 2021 11:03:42 PM",
    "status": true,
    "dimensionUnit": "in",
    "length": "14.5",
    "width": "14.5",
    "height": "15.0",
    "volumetricWeight": "0.66",
    "weightUnit": "lb",
    "sku": "NA",
    "actualWeight": "NA",
    "additionalInfo": "Object Measured Successfully"
}

				
			

Get Measurement by Measurment ID

The REST API call to this endpoint returns the response containing the measurement data of the corresponding measurement ID in the vMeasure system.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/dimension/<‘Measurement ID’>
Example: http://192.168.7.1:6600/api/dimension/5
Http Method: GET

Response:

				
					{
    "id": "5",   
    "scannedOn": "Fri Nov 26, 2021 11:03:42 PM",
    "status": true,
    "dimensionUnit": "in",
    "length": "14.5",
    "width": "14.5",
    "height": "15.0",
    "volumetricWeight": "0.66",
    "weightUnit": "lb",
    "sku": "NA",
    "actualWeight": "NA",
    "additionalInfo": "Object Measured Successfully"	
}

				
			

Note: The Measurement ID(id) should be prefixed by ‘B’ up to the application version 1.25

Get Measurements between the Range of Measurement IDs

The REST API call to this endpoint returns the response containing the list of measurement data between the range of measurement IDs requested to the connected vMeasure systems.

Request:

Endpoint: http://<‘IP address of the vision box’>:6600/api/dimension/
Example: http://192.168.7.1:6600/api/dimension/
Http Method: GET
Request Header:
				
					{
“range”: “id”, 
“from”: ”1”, 
“to”: ”100” 
}
				
			

Response:

				
					[{
    "id": "1",   
    "scannedOn": "Fri Nov 26, 2021 11:03:42 PM",
    "status": true,
    "dimensionUnit": "in",
    "length": "14.5",
    "width": "14.5",
    "height": "15.0",
    "volumetricWeight": "0.66",
    "weightUnit": "lb",
    "sku": "NA",
    "actualWeight": "NA",
    "additionalInfo": "Object Measured Successfully"
},...,
{
    "id": "100",   
    "scannedOn": "Fri Nov 26, 2021 11:19:42 PM",
    "status": true,
    "dimensionUnit": "in",
    "length": "14.5",
    "width": "14.5",
    "height": "15.0",
    "volumetricWeight": "0.66",
    "weightUnit": "lb",
    "sku": "NA",
    "actualWeight": "NA",
    "additionalInfo": "Object Measured Successfully"
}
] 

				
			

Get Measurement between the Range of Dates

The REST API call to this endpoint returns the response containing the list of measurement data of all the measurements between from and to dates mentioned in the request header.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/dimension/
Example: http://192.168.7.1:6600/api/dimension/
Http Method: GET
Request Header:
				
					{
“range”: “date”,
“from”: ”YYYY-MM-DD”,
“to”: ”YYYY-MM-DD”
}
				
			

Response:

				
					[{ 
    "id": "46",   
    "scannedOn": "Fri Jan 01, 2021 04:43:54 PM",
    "status": true,
    "dimensionUnit": "in",
    "length": "14.5",
    "width": "14.5",
    "height": "15.0",
    "volumetricWeight": "0.66",
    "weightUnit": "lb",
    "sku": "NA",
    "actualWeight": "NA",
    "additionalInfo": "Object Measured Successfully"
},...,{
    "id": "120", 
    "scannedOn": "Thu Jan 07, 2021 08:00:07 PM",
    "status": true,
    "dimensionUnit": "in",
    "length": "14.5",
    "width": "14.5",
    "height": "15.0",
    "volumetricWeight": "0.66",
    "weightUnit": "lb",
    "sku": "NA",
    "actualWeight": "NA",
    "additionalInfo": "Object Measured Successfully"
}]

				
			

Get Measurement ID List

The REST API call to this endpoint returns the response containing the list of measurement ID and measurement date and time for all the measurements from the vMeasure system.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/scanidlist/
Example: http://192.168.7.1:6600/api/scanidlist/
Http Method: GET

Response:

				
					[{
        "id": "109",
        "scannedOn": "Wed Oct 06, 2021 07:21:13 PM"
},
{
        "id": "110",
        "scannedOn": "Wed Oct 06, 2021 07:31:30 PM"
}] 
				
			

Get Latest Measurement Image

The REST API call to this endpoint returns the JPEG image file of the latest measurement from the vMeasure system as the response.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/image/
Example: http://192.168.7.1:6600/api/image/
Http Method: GET

Response:

The image file of the latest measurement in JPEG format is sent as a response from the server. A successful response must be HTTP response code 200 (OK).

Get Image by Measurement ID

The REST API call to this endpoint returns the JPEG image file of the measurement corresponding to the measurement ID specified in the request.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/image/<‘Measurement ID’>
Example: http://192.168.7.1:6600/api/image/7
Http Method: GET

Response:

The image file of the corresponding measurement ID in JPEG format is sent as a response from the server. A successful response must be HTTP response code 200 (OK).

Get System Information

The REST API call to this endpoint returns the response containing the information specific to the vMeasure system, such as the application version, SDK version, and mac address.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/deviceinfo/
Example: http://192.168.7.1:6600/api/deviceinfo/
Http Method: GET

Response:

				
					{
"appVersion": "1.21",
"macAddress": "00:04:4b:e5:5b:f1",
"sdkVersion": "2.0.10",
"model": "vMeasure S100 – Gen 1.3",
"minLen": "11.8",
"maxLen": "31.8",
"minWid": "11.8",
"maxWid": "31.8",
"minHgt": "11.8",
"maxHgt": "31.8",
"dimDiv": "0.2",
"dimUnits": "in",
}
				
			

Measure API

The REST API call to this below endpoint returns the response containing the measurement data of the connected vMeasure dimensional weight scanner system.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/measure/
Example: http://<192.168.7.1>:6600/api/measure/
Http Method: GET

Response:

				
					"id": "19",   
    "scannedOn": "Fri Feb 25, 2022 08:04:45 PM",
    "status": true,
    "dimensionUnit": "in",
    "length": "9.5",
    "width": "5.5",
    "height": "10.5",
    "volumetricWeight": "23.3",
    "weightUnit": "NA",
    "sku": "NA",
    "actualWeight": "NA",
    "additionalInfo": "Object Measured Successfully"
				
			
Note: The Measure API available from the version 4.0

Modifying Response Type

vMeasure API server sends the response in JSON format by default. However, by specifying the media-type field in the API request headers, you can make the server to send the response data in the XML format or CSV format.
The below example describes the request example for getting the latest measurement data in the XML format.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/dimension/
Example: http://192.168.7.1:6600/api/dimension/
Http Method: GET
Request Header:
				
					Content-Type: "application/xml"
				
			

Response:

				
					<?xml version="1.0" encoding="iso-8859-1"?>
<dimension>
    <id>20851</id>
    <scannedOn>Fri Nov 26, 2021 11:03:39 PM</scannedOn>
    <status>true</status>
    <dimensionUnit>in</dimensionUnit>
    <length>14.5</length>
    <width>14.5</width>
    <height>15.0</height>
    <volumetricWeight>0.66</volumetricWeight>
    <weightUnit>lb</weightUnit>
    <sku>NA</sku>
    <actualWeight>NA</actualWeight>
    <additionalInfo>Object Measured Successfully</additionalInfo>
</dimension>

				
			
The below example describes the request for getting the latest measurement data in the CSV format.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/dimension/
Example: http://192.168.7.1:6600/api/dimension/
Http Method: GET
Request Header:
				
					Content-Type: "application/csv"
				
			

Response:

				
					"id","scannedOn","status","dimensionUnit","weightUnit","l
ength","width","height","volumetricWeight","actualWeight"
,"sku","additionalInfo"
"146","Wed Jun 16, 2021 09:29:27 PM",true,"in","lb",
"17.5","10.5","6.5","0.24","NA","NA","Object Measured Successfully"
				
			

Delete Measurements between the Range of Measurement IDs

The REST API call to this endpoint deletes the dimension data and images corresponding to the measurement ID specified in the request URL from the local storage of the connected vMeasure system.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/dimension/<‘Measurement ID’>
Example: http://192.168.7.1:6600/api/dimension/2
Http Method: DELETE

Response:

				
					A successful response must be HTTP response code 200 (OK) and the server response does not include any message body.
				
			
Note: The Measurement ID should be prefixed by ‘B’ up to the application version 1.25

Delete Dimension Data

The call to this API endpoint deletes the measurement data and images corresponding to range ID specified in the request URL, from the local storage of connected vMeasure system.

Request:

Endpoint: http://<'IP address of the vision box'>:6600/api/dimension/
Example: http://<192.168.7.1>:6600/api/dimension/
Request Header:
				
					{
“range”: “id”,
“from”: ”1”,
“to”: ”100”
}

				
			
Http Method: DELETE

Response:

				
					A successful response must be HTTP response code 200 (OK) and the server response does not include any message body.
				
			
Note: Range Delete API available from the version 4.0