Retrieve Trigger by Trigger ID

GET /v2/triggers/{triggerId}

Retrieving a trigger for MDNless is similar to retrieving any trigger in Connectivity Management. The only difference is a few new values added in the response for MDNless. This page will cover the new values and provide examples of what responses look like with the new values. 

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

Parameter Name Data Type Description
triggerId
required		 string The system assigend identifier of the trigger being queried.

HTTP Request

GET https://thingspace.verizon.com/api/m2m/v2/triggers/0C82E389-1305-40C7-8DD3-E6FDDC984F7D

Success Response

Status 200

{
    "triggers": [
        {
            "triggerId": "0C82E389-1305-40C7-8DD3-E6FDDC984F7D",
            "triggerName": "PromoAlerts_0000123456-00001_12345",
            "accountName": "0000123456-00001",
            "organizationName": "Mdnless_org_name",
            "triggerCategory": "PromoAlerts",
            "promoAlerts": {
                "filterCriteria": {
                    "servicePlan": "12345"
                },
                "condition": {
                    "dataPercentage50": false,
                    "dataPercentage75": false,
                    "dataPercentage90": false,
                    "dataPercentage100": true,
                    "smsPercentage50": false,
                    "smsPercentage75": false,
                    "smsPercentage90": false,
                    "smsPercentage100": true,
                    "noOfDaysB4PromoExp": 0
                },
                "enablePromo": true
            },
            "active": true,
            "createdAt": "2021-08-25T14:46:011.347Z",
            "modifiedAt": "2022-02-21T22:39:045.227Z"
        }
    ]
}

Response Body

Parameter Name Data Type Description
triggerId
 string The system assigned ID of the Trigger.
triggerName
 object The system assigned name of the trigger. When the trigger is associated with MDNless, the name will show "PromoAlerts".
accountName
 string The name of the account. An account name is usually numeric and must include any leading zeros.

organizationName

 string An optional group name added when the trigger is created.

triggerCategory

 string

The category of the trigger. for MDNless this category will always be "PromoAlerts"

promoAlerts

 array

An array of additional information for the trigger.

promoAlerts.filterCriteria

 object

The filter information used to identify the trigger.

promoalerts.filterCriteria.ServicePlan

 string

The customer's service plan associated with the trigger.

promoAlerts.DataPercentage50

 boolean

Whether or not the usage has exceeded 50% of the account's total usage allowed.

  • true
  • false
promoAlerts.DataPercentage75 boolean

Whether or not the usage has exceeded 75% of the account's total usage allowed.

  • true
  • false
promoAlerts.DataPercentage90 boolean

Whether or not the usage has exceeded 90% of the account's total usage allowed.

  • true
  • false
promoAlerts.DataPercentage100 boolean

Whether or not the usage has exceeded 100% of the account's total usage allowed.

  • true
  • false
promoAlerts.SmsPercentage50 boolean

Whether or not the number of SMS messages has exceeded 50% of the account's total usage allowed.

  • true
  • false
promoAlerts.SmsPercentage75 boolean

Whether or not the number of SMS messages has exceeded 75% of the account's total usage allowed.

  • true
  • false
promoAlerts.SmsPercentage90 boolean

Whether or not the number of SMS messages has exceeded 90% of the account's total usage allowed.

  • true
  • false
promoAlerts.SmsPercentage100 boolean

Whether or not the number of SMS messages has exceeded 100% of the account's total usage allowed.

  • true
  • false
promoAlerts.NoOfDaysB4PromoExp integer The number of days until the promotional billing rate for MDNless ends.
promoAlerts.EnablePromo boolean

Whether or not the promotional billing rate is enabled.

  • true - rate enabled
  • false - rate is not enabled
active boolean

Whether or not the promotional billing rate is currently active.

  • true - rate active
  • false - rate is not active
createdAt string(date-time)

The time stamp of when the trigger was created.
modifiedAt string(date-time)

The time stamp of the most recent time the trigger was modified.

Failure Response

All failure responses are 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!