Get check in history for a device

Get Check-in History for a Device

`GET /logging/{accountName}/devices/{deviceId}/checkInHistory`

Gets check-in history for a device in your account, not necessarily with logging enabled.

Uses and Requirements

Devices using HTTP for FOTA learn about new campaigns as they check-in to the FOTA system. Generally, devices are recommended to check-in once a day and at power on / power cycle. Device OEMs may decide to check-in more or less frequently depending on the use case of the IoT device. This history shows when the particular device checked-in.

HTTP Request

GET https://thingspace.verizon.com/api/fota/v2/logging/{acc}/devices/{deviceId}/checkInHistory

Resource Path Parameters

You must include the account name and the deviceId in the path.

Parameter Name	Data Type	Description
accountName required	string	The name of the account for which you want the list of devices. An account name is usually numeric, and must include any leading zeros.
deviceId required	required string	The device IMEI identifier.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.

Parameter Name	Data Type	Description
Authorization required	string	HTTP Authorization bearer token: `Authorization: Bearer {token}`
VZ-M2M-Token required	string	A valid session token: `VZ-M2M-Token: {M2Mtoken}`

Request Body

None.

Example Request

Get check-in history for a device:

curl https://thingspace.verizon.com/api/fota/v2/logging/$ACC/devices/$DEVICEID/checkInHistory  -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN'

Success Responses

Status 200

A success response contains a list of check-in history entries.

Parameter Name	Data Type	Description
deviceId	string	The IMEI of the device.
clientType	string	Client type ID and client type. Valid values include: `0-Unknown`, `1-Device`, `3-RovaContainer`, `5-WiFiClient`, `6-RovaClient`, `7-RovaClientAppStore`
result	string	Result. Valid values include: `0-Failed`, `1-Succeeded`, `2-Busy`
failureType	string	Failure type. Valid values include: `0-None`, `1-UnspecifiedError`, `2-AuthenticationFailure`, `3-EnrollmentPolicyFailure`, `4-DecryptionFailure`, `5-NoAssignedSetting`, `6-EncryptionFailure`, `7-ConfigurationErrors`
timeCompleted	string($date)	The time completed.

Example Success Response

[    {        "deviceId": "990013907835573",        "clientType": "string",        "result": "string",        "failureType": "string",        "timeCompleted": "2020-10-22T19:35:07.753Z"    }]

Failure Responses

Status 400

All error messages are returned in this format:

{    "errorCode": "error code string",    "errorMessage": "error message string"}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

# Get Check-in History for a Device ### `GET /logging/{accountName}/devices/{deviceId}/checkInHistory` Gets check-in history for a device in your account, not necessarily with logging enabled. ## Uses and Requirements Devices using HTTP for FOTA learn about new campaigns as they check-in to the FOTA system. Generally, devices are recommended to check-in once a day and at power on / power cycle. Device OEMs may decide to check-in more or less frequently depending on the use case of the IoT device. This history shows when the particular device checked-in. ## HTTP Request GET [https://thingspace.verizon.com/api/fota/v2/logging/{acc}/devices/{deviceId}/checkInHistory](/docs/premium-apis/software-management/software-management-v2/api-endpoints/server-logging/getdevicecheckinhistory) ## Resource Path Parameters You must include the account name and the deviceId in the path. | Parameter Name | Data Type | Description | |:----------------|:-----------|:-------------| | **accountName** *required* | string | The name of the account for which you want the list of devices. An account name is usually numeric, and must include any leading zeros. | | **deviceId** *required* | required string | The device IMEI identifier. | ## Header Parameters The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit [Getting Started](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/guides/getting-started). | Parameter Name | Data Type | Description | |:-----------------------|:-----------|:-----------------------------------------------------------------------------| | **Authorization** _required_ | string | HTTP Authorization bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** _required_ | string | A valid session token: `VZ-M2M-Token: {M2Mtoken}` | ## Request Body None. ## Example Request Get check-in history for a device: ```json curl https://thingspace.verizon.com/api/fota/v2/logging/$ACC/devices/$DEVICEID/checkInHistory -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN' ``` ## Success Responses **Status 200** A success response contains a list of check-in history entries. | Parameter Name | Data Type | Description | |:----------------|:-----------|:-------------| | **deviceId** | string | The IMEI of the device. | | **clientType** | string | Client type ID and client type. Valid values include: `0-Unknown`, `1-Device`, `3-RovaContainer`, `5-WiFiClient`, `6-RovaClient`, `7-RovaClientAppStore` | | **result** | string | Result. Valid values include: `0-Failed`, `1-Succeeded`, `2-Busy` | | **failureType** | string | Failure type. Valid values include: `0-None`, `1-UnspecifiedError`, `2-AuthenticationFailure`, `3-EnrollmentPolicyFailure`, `4-DecryptionFailure`, `5-NoAssignedSetting`, `6-EncryptionFailure`, `7-ConfigurationErrors` | | **timeCompleted** | string($date) | The time completed. | ## Example Success Response ```json [ { "deviceId": "990013907835573", "clientType": "string", "result": "string", "failureType": "string", "timeCompleted": "2020-10-22T19:35:07.753Z" } ] ``` ## Failure Responses **Status 400** All error messages are returned in this format: ```json { "errorCode": "error code string", "errorMessage": "error message string" } ``` Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Verizon 5G Edge API Portal

Get check in history for a device