Update Thing Description

This guide will show you how you can update your Thing description via API.

Please note that in order to update Thing description we will need to run 2 API commands:

1. Get Thing cas value

2. Update Thing Information

1st API command - get Thing cas value

Get Thing information

GET https://console.monogoto.io/thing/ThingId_ICCID_{ICCID}

Path Parameters

Name	Type	Description
ICCID*	String	The ICCID of your SIM

Headers

Name	Type	Description
YOUR_TOKEN*	String	Your authentication token

200: OK OK

{
  "Type": "string",
  "PricePlanInnerId": "string",
  "ThingId": "string",
  "CustomerId": "string",
  "ThingName": "string",
  "ThingDescription": "string",
  "ThingsGroupId": "string",
  "ExternalUniqueId": "string",
  "ExternalUniqueType": "string",
  "ExternalBatchId": "string",
  "BatchId": "string",
  "SubProfId": "string",
  "NetworkProviderId": "string",
  "RoamingPolicyId": "string",
  "GeoDistance": 0,
  "ThingTag": [
    "string"
  ],
  "Latitude": 0,
  "Longitude": 0,
  "FencingRadius": 0,
  "UnavailabilityTime": "2022-05-30T09:53:47.060Z",
  "IPv4": "string",
  "IPv4PoolId": "string",
  "IPv4AllocationPolicy": "string",
  "IPv4Lock": true,
  "IPv6": "string",
  "IPv6PoolId": "string",
  "IPv6AllocationPolicy": "string",
  "IPv6Lock": true,
  "FwBlockAttempts": 0,
  "StreetAddress": "string",
  "Remarks": "string",
  "hss": {
    "serviceSelection": "string",
    "pdnType": 0,
    "vplmnDynamicAddressAllowed": 0,
    "PDNgwAllocationType": 0,
    "ambr": {
      "maxRequestedBandwidthUL": 0,
      "maxRequestedBandwidthDL": 0
    },
    "epsQos": {
      "qosClassIden": 0,
      "priorityLevel": 0,
      "preemptionCapability": 0,
      "preemptionVulnerability": 0
    }
  },
  "State": "string",
  "BillingState": "string",
  "DateCreated": 0,
  "DateModified": 0,
  "DateAssignedToCustomer": 0,
  "IMEI": "string",
  "MasterIMEI": "string",
  "LockMasterImei": true,
  "IMSI": "string",
  "MSISDN": "string",
  "VcsAccountId": "string",
  "LastLocation": {
    "Timestamp": 0,
    "Type": "string",
    "Latitude": 0,
    "MCC": "string",
    "MNC": "string",
    "Longitude": 0,
    "AccuracyInKM": 0,
    "IMSI": "string",
    "IsLocationTypeAccurate": true,
    "CellId": 0,
    "Lac": 0
  },
  "LastAccuracyLocation": {
    "Timestamp": 0,
    "Type": "string",
    "Latitude": 0,
    "MCC": "string",
    "MNC": "string",
    "Longitude": 0,
    "AccuracyInKM": 0,
    "IMSI": "string",
    "IsLocationTypeAccurate": true,
    "CellId": 0,
    "Lac": 0
  },
  "RoamingRestrictions": [
    {
      "BlockRoaming": true,
      "BlockSMS": true,
      "BlockMOVoiceFlag": true,
      "BlockMTVoiceFlag": true,
      "DataRestrictionByterateLimit": "string",
      "MNOId": "string",
      "Preferred": true,
      "RoamingPartnerId": 0,
      "RoamingPlanId": "string",
      "ByterateFlag": true,
      "BlockMOSMSFlag": true
    }
  ],
  "Block": {
    "Data2G": true,
    "Data": true,
    "LTEData": true,
    "Data5G": true,
    "SMS_MO": true,
    "SMS_MT": true,
    "Supplementary_Services": true,
    "Voice_International": true,
    "Voice_International_Exc_Home": true,
    "Voice_MO": true,
    "Voice_MT": true,
    "Voice_Premium": true
  },
  "ActualUsage": {
    "MO_SMS_CDR_": 0,
    "Data_": 0,
    "Voice_": 0,
    "Alarm": 0
  },
  "APN": {
    "ShortId": "string",
    "DateModified": "string",
    "Name": "string",
    "ApnId": "string",
    "Description": "string",
    "IpRange": "string",
    "Ipv6Range": "string",
    "Type": "string",
    "InterfaceName": "string",
    "ServedByJpU": true,
    "DynamicIPAddress": true,
    "pdpsub": {
      "Delay-Class": 0,
      "Mean-Throughput": 0,
      "Pdp-ContextId": 0,
      "Peak-Throughput": 0,
      "Precedence-Class": 0,
      "Reliability-Class": 0,
      "PreferredDataMode": 0,
      "NonIpDataDelvMechanism": 0,
      "NonIPPDNTypeIndicator": 0,
      "qos": {
        "Delivery-Of-Erroneous-SDU": 0,
        "Delivery-Order": 0,
        "Guaranteed-Bit-Rate-For-DownLink": 0,
        "Guaranteed-Bit-Rate-For-Uplink": 0,
        "Guaranteed-Bit-Rate-ForDownlink(extended)": 0,
        "Maximum-Bit-Rate-For-Downlink": 0,
        "Maximum-Bit-Rate-For-Downlink(extended)": 0,
        "Maximum-Bit-Rate-For-Uplink": 0,
        "Maximum-SDU-Size": 0,
        "Priority": 0,
        "Residual-BER": 0,
        "SDU-Error-Ratio": 0,
        "Signaling-Indication": 0,
        "Source-Statistics-Descriptor": 0,
        "Traffic-Class": 0,
        "Traffic-Handling-Priority": 0,
        "Transfer-Delay": 0
      }
    }
  },
  "cas": "string"
}

401: Unauthorized Unauthorized

{
    Unauthorized
}

500: Internal Server Error Internal Server Error

{
    Error: CouchbaseError: The key does not exist on the server
}

404: Not Found Not found

{
    Not found
}

Add your Thing ICCID and Token in the GET request to successfully obtain the Thing info.

Example using cURL:

curl -X GET \
     --url "https://console.monogoto.io/thing/ThingId_ICCID_{THING_ICCID}/" \
     -H "accept: application/json" \
     -H "Authorization: Bearer {YOUR_TOKEN}"

Example of response to our request:

      "State": "ACTIVE",
      "Status": "Serving",
      "SubProfId": "SubProfId_5652ayf1-er9c-4914-a60b-630cc4af0a2b",
      "ThingId": "ThingId_ICCID_8912372646888991",
      "Type": "MobileSubscriber",
      "VcsAccountId": null,
      "cas": 1236781245913489491,
      "ActualUsage": {
        "MO_SMS_CDR_": 3,
        "Data_": 45919688,
        "Voice_": 0,
        "Alarm": 0

Returns a single Thing

GEThttps://console.monogoto.io/thing/{ThingId}/

Path parameters

ThingId*string

Thing ID

Response

200401404500

Thing object identified by the Thing ID parameters

Body

application/json

Typestring

Type

PricePlanInnerIdstring

Price Plan Inner ID

ThingIdstring

Thing identifier

CustomerIdstring

Customer ID

ThingName*string

Thing Name

ThingDescriptionstring

Thing Description

ThingsGroupIdstring

Things Group ID

ExternalUniqueIdstring

ExternalUniqueId

ExternalUniqueType*string

External Unique Type

ExternalBatchId*string

External Batch ID

BatchId*string

Batch ID

SubProfId*string

Subscription Profile ID

NetworkProviderIdstring

Network Provider ID

RoamingPolicyIdstring

Roaming Policy Id

GeoDistancenumber (float)

Distance in meters between expected and current location

ThingTagarray of string

Thing tags

Latitudenumber (float)

Thing GEO Location

Longitudenumber (float)

Thing GEO Location

FencingRadiusnumber (int64)

Fencing Radius of the device. Updated on GEO Fencing Breach

UnavailabilityTimestring (date-time)

How long the Thing is unavailable

IPsarray of ThingIP (object)

An array of thing allocated IP addresses

FwBlockAttemptsnumber (int64)

Firewall block attempt number

StreetAddressstring

Street address of the thing

Remarksstring

Free-text user-defined remarks about the thing

hssthingHss (object)

Statestring

State of the thing

BillingStatestring

Billing State of the thing

DateCreatednumber

Document Created Date

DateModifiednumber

Document Modified Date

DateAssignedToCustomernumber

Transferred to account date and time

IMEIstring

International Mobile Equipment Identity

MasterIMEIstring

Original IMEI

LockMasterImeiboolean

Block/unblock service according to master IMEI attribute if this flag on true

SetPLMNByOTAStatestring

Allowed three states : Inherits - take from next hierarchy level (Thing Group, Customer) , Enable - will create OTA Campaign with OPLMN , PLMN Sel operations if the subscriber connected to network in different country, Disable - will NOT create OTA Campaign

WelcomeSMSStatestring

Allowed three states : Inherits - take from next hierarchy level (Thing Group, Customer) , Enable - will send welcome SMS if the subscriber connected to network in different country, Disable - will NOT send welcome SMS

IMSIstring

International Mobile Subscriber Identity

MSISDNstring

Mobile Subscriber Integrated Services Digital Number

VcsAccountIdstring

VCS Account ID

LastLocationlastLocation (object)

LastAccuracyLocationlastLocation (object)

RoamingRestrictionsarray of RoamingRestrictions (object)

Roaming Restrictions

PricePlansarray of GetThingsPricePlans (object)

Price Plans

BlockBlockForThing (object)

ActualUsageActualUsage (object)

APNthingApn (object)

casstring

indicator of version

Request

JavaScriptCurlPython

const response = await fetch('https://console.monogoto.io/thing/{ThingId}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404500

{
  "Type": "text",
  "PricePlanInnerId": "text",
  "ThingId": "text",
  "CustomerId": "text",
  "ThingName": "text",
  "ThingDescription": "text",
  "ThingsGroupId": "text",
  "ExternalUniqueId": "text",
  "ExternalUniqueType": "text",
  "ExternalBatchId": "text",
  "BatchId": "text",
  "SubProfId": "text",
  "NetworkProviderId": "text",
  "RoamingPolicyId": "text",
  "GeoDistance": 0,
  "ThingTag": [
    "text"
  ],
  "Latitude": 0,
  "Longitude": 0,
  "FencingRadius": 0,
  "UnavailabilityTime": "2024-12-21T16:23:42.719Z",
  "IPs": [
    {
      "IP": "text",
      "IPPoolId": "text",
      "NetworkId": "text",
      "IPvType": "text",
      "IPLock": "text",
      "IPAllocationPolicy": "text"
    }
  ],
  "FwBlockAttempts": 0,
  "StreetAddress": "text",
  "Remarks": "text",
  "hss": {
    "serviceSelection": "text",
    "pdnType": 0,
    "vplmnDynamicAddressAllowed": 0,
    "PDNgwAllocationType": 0,
    "ambr": {
      "maxRequestedBandwidthUL": 0,
      "maxRequestedBandwidthDL": 0
    },
    "epsQos": {
      "qosClassIden": 0,
      "priorityLevel": 0,
      "preemptionCapability": 0,
      "preemptionVulnerability": 0
    }
  },
  "State": "text",
  "BillingState": "text",
  "DateCreated": 0,
  "DateModified": 0,
  "DateAssignedToCustomer": 0,
  "IMEI": "text",
  "MasterIMEI": "text",
  "LockMasterImei": false,
  "SetPLMNByOTAState": "text",
  "WelcomeSMSState": "text",
  "IMSI": "text",
  "MSISDN": "text",
  "VcsAccountId": "text",
  "LastLocation": {
    "Timestamp": 0,
    "Type": "text",
    "Latitude": 0,
    "MCC": "text",
    "MNC": "text",
    "Longitude": 0,
    "AccuracyInKM": 0,
    "IMSI": "text",
    "IsLocationTypeAccurate": false,
    "CellId": 0,
    "Lac": 0
  },
  "LastAccuracyLocation": {
    "Timestamp": 0,
    "Type": "text",
    "Latitude": 0,
    "MCC": "text",
    "MNC": "text",
    "Longitude": 0,
    "AccuracyInKM": 0,
    "IMSI": "text",
    "IsLocationTypeAccurate": false,
    "CellId": 0,
    "Lac": 0
  },
  "RoamingRestrictions": [
    {
      "BlockRoaming": false,
      "BlockSMS": false,
      "BlockMOVoiceFlag": false,
      "BlockMTVoiceFlag": false,
      "DataRestrictionByterateLimit": "text",
      "MNOId": "text",
      "Preferred": false,
      "RoamingPartnerId": 0,
      "RoamingPlanId": "text",
      "ByterateFlag": false,
      "BlockMOSMSFlag": false
    }
  ],
  "PricePlans": [
    {
      "NetworkProviderId": "text",
      "PricePlanInnerId": "text"
    }
  ],
  "Block": {
    "Data2G": false,
    "Data": false,
    "LTEData": false,
    "Data5G": false,
    "SMS_MO": false,
    "SMS_MT": false,
    "Supplementary_Services": false,
    "Voice_International": false,
    "Voice_International_Exc_Home": false,
    "Voice_MO": false,
    "Voice_MT": false,
    "Voice_Premium": false
  },
  "ActualUsage": {
    "MO_SMS_CDR_": 0,
    "Data_": 0,
    "Voice_": 0,
    "Alarm": 0
  },
  "APN": {
    "ShortId": "text",
    "DateModified": "text",
    "Name": "text",
    "ApnId": "text",
    "Description": "text",
    "IpRange": "text",
    "Type": "text",
    "InterfaceName": "text",
    "ServedByJpU": false,
    "DynamicIPAddress": false,
    "pdpsub": {
      "Delay-Class": 0,
      "Mean-Throughput": 0,
      "Pdp-ContextId": 0,
      "Peak-Throughput": 0,
      "Precedence-Class": 0,
      "Reliability-Class": 0,
      "qos": {
        "Delivery-Of-Erroneous-SDU": 0,
        "Delivery-Order": 0,
        "Guaranteed-Bit-Rate-For-DownLink": 0,
        "Guaranteed-Bit-Rate-For-Uplink": 0,
        "Guaranteed-Bit-Rate-ForDownlink(extended)": 0,
        "Maximum-Bit-Rate-For-Downlink": 0,
        "Maximum-Bit-Rate-For-Downlink(extended)": 0,
        "Maximum-Bit-Rate-For-Uplink": 0,
        "Maximum-SDU-Size": 0,
        "Priority": 0,
        "Residual-BER": 0,
        "SDU-Error-Ratio": 0,
        "Signaling-Indication": 0,
        "Source-Statistics-Descriptor": 0,
        "Traffic-Class": 0,
        "Traffic-Handling-Priority": 0,
        "Transfer-Delay": 0
      }
    }
  },
  "cas": "text"
}

2nd API command - Update Thing Information

Put Thing information

PUT https://console.monogoto.io/thing/update

Headers

Name	Type	Description
YOUR_TOKEN*	String	Your authentication token

Request Body

Name	Type	Description
ICCID*	String	The ICCID of your SIM
NEW_DESCRIPTION*	String	Description you wish your Thing to have
CAS*	String	Value to confirm that you are using latest information for Thing

200: OK OK

{
  "PricePlanInnerId": "string",
  "ThingId": "string",
  "ThingName": "string",
  "ThingDescription": "string",
  "ThingsGroupId": "string",
  "NetworkProviderId": "string",
  "RoamingPolicyId": "string",
  "ThingTag": [
    "string"
  ],
  "Latitude": 0,
  "Longitude": 0,
  "FencingRadius": 0,
  "UnavailabilityTime": "2022-06-21T10:57:26.629Z",
  "IPv4": "string",
  "IPv4Lock": true,
  "IPv6": "string",
  "IPv6Lock": true,
  "PIN1": "string",
  "PIN2": "string",
  "PUK1": "string",
  "PUK2": "string",
  "FwBlockAttempts": 0,
  "StreetAddress": "string",
  "Remarks": "string",
  "MasterIMEI": "string",
  "LockMasterImei": true,
  "MSISDN": "string",
  "RoamingPolicies": [
    {
      "NetworkProviderId": "string",
      "RoamingPolicyId": "string",
      "RoamingRestrictions": [
        {
          "BlockRoaming": true,
          "BlockSMS": true,
          "BlockMOVoiceFlag": true,
          "BlockMTVoiceFlag": true,
          "DataRestrictionByterateLimit": "string",
          "MNOId": "string",
          "Preferred": true,
          "RoamingPartnerId": 0,
          "RoamingPlanId": "string",
          "ByterateFlag": true,
          "BlockMOSMSFlag": true
        }
      ]
    }
  ],
  "Block": {
    "Data2G": true,
    "Data": true,
    "LTEData": true,
    "Data5G": true,
    "SMS_MO": true,
    "SMS_MT": true,
    "Supplementary_Services": true,
    "Voice_International": true,
    "Voice_International_Exc_Home": true,
    "Voice_MO": true,
    "Voice_MT": true,
    "Voice_Premium": true
  },
  "SimType": "string",
  "cas": "string",
  "PricePlans": [
    {
      "NetworkProviderId": "string",
      "PricePlanInnerId": "string",
      "Override": false
    }
  ]
}

401: Unauthorized Unauthorized

{
    Unauthorized
}

500: Internal Server Error Internal Server Error

{
    Error: CouchbaseError: The key does not exist on the server
}

404: Not Found Not found

{
    Not found
}

400 Invalid Input Data

{
  "message": "string"
}

Example using cURL:

curl -X PUT \
   --url "https://console.monogoto.io/thing/update/" \
   -H "accept: application/json" \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer {YOUR_TOKEN}" \
   -d "{ \"ThingId\": \"ThingId_ICCID_{ICCID}\", \"ThingDescription\": \"{NEW_DESCRIPTION}\", \"cas\": \"{CAS}\"}"

Expected response:

{
    Thing undefined successfully saved.
}

Update a single ThingTake a look that the customer is not allowed to modify MSISDN

PUThttps://console.monogoto.io/thing/update/

Body

application/json

Updated thing parameters

PricePlanInnerIdstring

Price Plan Inner ID

ThingId*string

Thing identifier

ThingNamestring

Thing Name

ThingDescriptionstring

Thing Description

ThingsGroupIdstring

Things Group ID

NetworkProviderIdstring

Network Provider ID

RoamingPolicyIdstring

Roaming Policy Id

ThingTagsarray of string

Thing tags

Latitudenumber (float)

Thing GEO Location

Longitudenumber (float)

Thing GEO Location

FencingRadiusnumber (int64)

Fencing Radius of the device. Updated on GEO Fencing Breach

UnavailabilityTimestring (date-time)

How long the Thing is unavailable

IPsarray of ThingIP (object)

An array of thing allocated IP addresses

PIN1string

PIN1

PIN2string

PIN2

PUK1string

PUK1

PUK2string

PUK2

FwBlockAttemptsnumber (int64)

Firewall block attempt number

StreetAddressstring

Street address of the thing

Remarksstring

Free-text user-defined remarks about the thing

MSISDNstring

Mobile Subscriber Integrated Services Digital Number

MasterIMEIstring

Original IMEI

LockMasterImeiboolean

Block/unblock service according to master IMEI attribute if this flag on true

SetPLMNByOTAStatestring

Allowed three states : Inherits - take from next hierarchy level (Thing Group, Customer) , Enable - will create OTA Campaign with OPLMN , PLMN Sel operations if the subscriber connected to network in different country, Disable - will NOT create OTA Campaign

WelcomeSMSStatestring

Allowed three states : Inherits - take from next hierarchy level (Thing Group, Customer) , Enable - will send welcome SMS if the subscriber connected to network in different country, Disable - will NOT send welcome SMS

RoamingPoliciesarray of ThingRoamingPolicies (object)

Roaming Policies

BlockBlockForThing (object)

SimTypestring

Type of the SIM

casstring

indicator of version

PricePlansarray of ThingPricePlans (object)

Price Plans

Response

200400401500

Thing updated successfully

Request

JavaScriptCurlPython

const response = await fetch('https://console.monogoto.io/thing/update/', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ThingId": "text"
    }),
});
const data = await response.json();

Response

400401500

{
  "message": "text"
}