Update Cellular Module (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/elements/:element_id/cellular_modules/:cellular_module_id

Update a specific cellular module.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

element_id stringrequired

ID of the element.

cellular_module_id stringrequired

ID of the cellular module.

application/json

Body

description

The description of the cellular module. Max size = 256.

gps_enable booleanrequired

Indicates if the GPS is enabled for the cellular module.

id string

The ID of the cellular module.

name stringrequired

The name of the cellular module. Max size = 128.

primary_sim integerrequired

The primary SIM attribute of the cellular module.

radio_on booleanrequired

Indicates the radio on attribute.

tags string[]

An information field that can be added to identify the cellular module. Maximum 10 unique tags of length 1024 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The description of the cellular module. Max size = 256.

gps_enable booleanrequired

Indicates if the GPS is enabled for the cellular module.

id string

The ID of the cellular module.

name stringrequired

The name of the cellular module. Max size = 128.

primary_sim integerrequired

The primary SIM attribute of the cellular module.

radio_on booleanrequired

Indicates the radio on attribute.

tags string[]

An information field that can be added to identify the cellular module. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "gps_enable": true,
  "id": "string",
  "name": "string",
  "primary_sim": 0,
  "radio_on": true,
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "CELLULAR_MODULE_CONFIG_RADIO_ON_REQD"
      },
      {
        "code": "CELLULAR_MODULE_CONFIG_GPS_ENABLE_REQD"
      },
      {
        "code": "CELLULAR_MODULE_CONFIG_PRIMARY_SIM_REQD"
      },
      {
        "code": "CELLULAR_MODULE_CONFIG_INVALID_PRIMARY_SIM"
      },
      {
        "code": "CELLULAR_MODULE_CONFIG_NAME_CHANGE_NOT_SUPPORTED"
      },
      {
        "code": "CELLULAR_MODULE_CONFIG_UNSUPPORTED_DEVICESW"
      }
    ]
  }
}

Loading...