Get the current status of an asynchronous request:

GET /accounts/{accountname}/requests/{requestID}/status

Returns the current status of an asynchronous request that was made for a two-way provisioning transaction on a single device.

Contents

Uses and Requirements

You can request the status of asynchronous requests that were run for two-way provisioning transactions on a single device. Two-way provisioning transactions include Activate, Deactivate, Suspend, and Resume.

You cannot check the status of requests that operated on multiple devices or check the status of asynchronous requests for other APIs.

Request Components

HTTP Request

GET https://thingspace.verizon.com/api/m2m/v1/accounts/{accountname}/requests/{requestID}/status

Resource and Query Parameters

The URI path must include the account name and the request ID for which you want status.

Parameter Name Data Type Description
accountname
required		 string The name of the account that sent the asynchronous request.
requestID
required		 string The asynchronous transaction request ID, found in the synchronous response to the original request.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

 

Parameter Name Data Type Description
Authorization
required		 string HTTP Authorization bearer token.
VZ-M2M-Token
required		 string A valid session token returned by POST /session/login.
Content-Type
required		 string Must be application/json.

Request Body

None.

Success Responses

Status 200

A successful request returns the request ID and the current status:

Parameter Name Data Type Description
requestId string The unique ID of the asynchronous request.
status string The current status of the request:
  • Pending - The request is still being processed.
  • Success - The request has completed processing with no errors.
  • Failed - There were errors that prevented the request from being completed.

Example Success Response

{
  "requestId":"86c83330-4bf5-4235-9c4e-a83f93aeae4c",
  "status": "Success"
}

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.

Try It Out!