Device Manager API Response

The Device Manager Response contains the list of devices successfully registered or updated, or errors indicating why the device could not be authenticated. The authentication certificates must then be installed on each device. Download the Smart Inventory Tracker Installation Qualification Document for more information.

See the Body guidelines, Errors, and Body example for this message below.

A Curie 6 Known Issue impacts this response. See the TraceLink Release Summary: Curie 6 on the Customer Success Portal for more information.

Body guidelines

Element			Type	Description
errorInfoList			List Begin	The list of errors returned by the request. Only present if the request returned at least one error.
	errorInformation		Section Begin	The error information.
		deviceName	String	Required. The name of the device that failed authentication.
		deviceUniqueIdentifier	String	Required. The Machine (e.g. MAC) address of the device that failed authentication.
		errorMessage	String	Required. The errors returned by the request.
deviceConfigurationFileInformation			Section Begin	The list of environment URLs for each device added in the request. Present only if at least one device is added successfully.
	environment		String	Required. The environment URL that the device is registered on.
deviceSuccessList			List Begin	The list of devices that were successfully added, updated, or deleted with the request message. Present only if at least one device was successfully added, updated, or deleted.
	deviceSuccessInformation		Section Begin	The success information.
		deviceName	String	Required. The name of the device that was successfully added, updated, or deleted.
		deviceUniqueIdentifier	String	Required. The Machine (e.g. MAC) address of the device that was successfully added, updated, or deleted.
		successMessage	String	Required. A message indicating the success of the request. Possible options: For add action requests: `Device <deviceName> has been pre-registered successfully` For update action requests: `Device <deviceName> has been updated successfully` For delete action requests: `Device <deviceName> has been deleted successfully`

Errors

The Response includes errors returned by the original Device Administration Request, but does not return errors of its own.

Body example

Copy

{"deviceConfigurationFileInformation":
        {
            "environment": "https://ki53q5hjo0.execute-api.us-east-1.amazonaws.com/etapi/basic/qetauvir/devmgr"
        }
    "deviceSuccessList": 
        [{"deviceSuccessInformation": 
            [{"deviceName": "HH_1",
            "deviceUniqueIdentifier": "94:FB:29:29:0C:C5",
            "successMessage": "Device HH_1 has been pre-registered successfully"
            }]
        }]
}