Skip to main content

connectivity-manager-changelog-tpw-operator

Release 8.0​

RDTP-19476​

What's Changed​

GET /admins/suppliers/{supplier}/sims​
Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Changed property data (array)

    Changed items (object):

    New required properties:

    • ID

    • type

    • profiles

    • Added property ID (string)

      Uniq identifier of the sim card:

      • the ICCID when type is SINGLE_IMSI or MULTI_IMSI
      • the EID when type is ESIM

      For SINGLE_IMSI, the ID may be the IMSI.

    • Added property type (string)

      Enum values:

      • SINGLE_IMSI
      • MULTI_IMSI
      • ESIM

    • Added property deviceEnforcedIMEI (string)

      Enforced IMEI of the associated device

    • Added property deviceEUI (string)

      EUI of the associated device

    • Added property profiles (array)

      Items (object):

      • Property iccid (string)

        Integrated Circuit Card Identifier

      • Property imss (array)

        International Mobile Subscribers

        Items (object):

        • Property imsi (string)

          International Mobile Subscriber Identity

        • Property msisdn (string)

          Mobile Station International Subscriber Directory Number

        • Property hsmGroupID (string)

          ID of HSM group used to encrypt the Ki.

    • Deprecated property imsi (string)

      Replaced by ID.

      IMSI of the SIM card. This property is present only when type is SINGLE_IMSI.

    • Deprecated property deviceIMEI (string)

      Replaced by deviceEnforcedIMEI.

Parameters:​

Added: imei in query

When specified, only the SIM card associated to a device matching the IMEI are returned (prefix match).

Added: msisdn in query

MSISDN of the SIM card. When specified, only the SIM cards matching the MSISDN are returned (prefix match).

Added: iccid in query

ICCID of the SIM card. When specified, only the SIM cards matching the ICCID are returned (prefix match).

Added: ID in query

ID of the SIM card. When specified, only the SIM cards matching the ID are returned (prefix match).

POST /admins/suppliers/{supplier}/sims/import​
Request:​

Import CSV now handle creation and modification of the new MULTI_IMSI and ESIM types.

New columns for the CREATE directive:

ColumnDefinitionCardinality
Ftype
Enum: SINGLE_IMSI, MULTI_IMSI, ESIM		Mandatory
G

ID
Uniq identifier of the SIM:

  • the ICCID when type is SINGLE_IMSI or MULTI_IMSI
  • the EID when type> is ESIM
Mandatory
H

ICCID
When type is MULTI_IMSI, the value should be the same as ID.

Mandatory
IMSISDNOptional

New ADD_IMSI directive to add an IMSI to a SIM:

ColumnDefinitionCardinality
AProcessing directive: ADD_IMSIMandatory
BIMSI
Syntax: from 10 to 15 decimal digits		Mandatory
C

Secret key associated to the IMSI (Ki)
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with Exchange Key (RSA) version specified in column E (base64 encoding)
Mandatory
DHSM group IDOptional
EHSM Exchange Key (RSA) version used to encrypt KiOptional
Ftype
Enum: MULTI_IMSI, ESIM		Mandatory
G

ID
Uniq identifier of the SIM:

  • the ICCID when type is MULTI_IMSI
  • the EID when type> is ESIM
Mandatory
H

ICCID
When type is MULTI_IMSI, the value should be the same as ID.

Mandatory
IMSISDNOptional

New REMOVE_IMSI to remove an IMSI from a SIM

ColumnDefinitionCardinality
AProcessing directive: REMOVE_IMSIMandatory
BIMSI
Syntax: from 10 to 15 decimal digits		Mandatory
Cn/a
Dn/a
En/a
Ftype
Enum: MULTI_IMSI, ESIM		Mandatory
G

ID
Uniq identifier of the SIM:

  • the ICCID when type is MULTI_IMSI
  • the EID when type> is ESIM
Mandatory
H

ICCID
When type is MULTI_IMSI, the value should be the same as ID.

Optional
In/a
GET /admins/suppliers/{supplier}/sims/{sim}​
Parameters:​

Changed: sim in path

Unique identifier of the SIM, either:

  • the sequential integer (UID) of the SIM
  • the identifier (ID) of the SIM prefixed by id:
Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Changed property data (object)

    New required properties:

    • ID
    • profiles
    • type

    New optional properties:

    • imsi

    • Added property ID (string)

      Uniq identifier of the sim card:

      • the ICCID when type is SINGLE_IMSI or MULTI_IMSI
      • the EID when type is ESIM

      For SINGLE_IMSI, the ID may be the IMSI.

    • Added property type (string)

      Enum values:

      • SINGLE_IMSI
      • MULTI_IMSI
      • ESIM

    • Added property profiles (array)

      Items (object):

      • Property iccid (string)

        Integrated Circuit Card Identifier

      • Property imss (array)

        International Mobile Subscribers

        Items (object):

        • Property imsi (string)

          International Mobile Subscriber Identity

        • Property msisdn (string)

          Mobile Station International Subscriber Directory Number

        • Property hsmGroupID (string)

          ID of HSM group used to encrypt the Ki.

    • Deprecated property hsmGroupID (string)

      Replaced by profiles[0].imss[0].hsmGroupID.

      ID of HSM group used to encrypt the Ki. This property is present only when type is SINGLE_IMSI.

    • Added property deviceEnforcedIMEI (string)

      Enforced IMEI of the associated device

    • Added property deviceEUI (string)

      EUI of the associated device

    • Deprecated property imsi (string)

      Replaced by ID and profiles[0].imss[0].imsi.

      IMSI of the SIM card. This property is present only when type is SINGLE_IMSI.

    • Deprecated property deviceIMEI (string)

      Replaced by deviceEnforcedIMEI.

DELETE /admins/suppliers/{supplier}/sims/{sim}​
Parameters:​

Changed: sim in path

Unique identifier of the SIM, either:

  • the sequential integer (UID) of the SIM
  • the identifier (ID) of the SIM prefixed by id:

RDTP-21984​

What's Changed​

POST /admins/suppliers/{supplier}/sims/import​
Request:​

New column for the CREATE and ADD_IMSI directives:

ColumnDefinitionCardinality
J

Derived Operator Code associated to the IMSI (OPc)
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • NOTE: Encrypted with Exchange Key (RSA) mode is not yet supported
Optional

RDTP-23453​

What's Changed​

GET /admins/suppliers/{supplier}/sims​
Parameters:​

Changed: state in query

ALLOCATED value is removed: when associated with a device, a SIM card is always provisioned in the HSS

Return Type:​

Changed response : 200 OK

Successful RETRIEVE

  • Changed property data (array)

    • Changed property state (string)

      ALLOCATED value is removed: when associated with a device, a SIM card is always provisioned in the HSS

GET /admins/suppliers/{supplier}/sims/{sim}​
Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Changed property data (object)

    • Changed property state (string)

      ALLOCATED value is removed: when associated with a device, a SIM card is always provisioned in the HSS

Release 7.3​

RDTP-17900​

What's Changed​

All paths /admins/suppliers/\{supplier\}/*​
Parameters:​

Changed: supplier in path

Unique identifier of the supplier, either

  • the sequential integer (UID) of the supplier
  • the identifier (ID) of the supplier prefixed by id:
  • the string mine to reference the supplier of the authenticated user requesting the API

RDTP-19834​

What's Changed​

POST /admins/suppliers/{supplier}/connectivityPlans​

Create Plan

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    The following properties are now optional:

    • managedCustomerNetwork
    • marginOffset
    • nbTransOffset
GET /admins/suppliers/{supplier}/connectivityPlans/{plan}​

Retrieve Plan

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    The following properties are now optional:

    • managedCustomerNetwork
    • marginOffset
    • nbTransOffset
PUT /admins/suppliers/{supplier}/connectivityPlans/{plan}​

Update Plan

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    The following properties are now optional:

    • managedCustomerNetwork
    • marginOffset
    • nbTransOffset

Release 7.2​

No change

Release 7.1​

RDTP-18668​

What's Changed​

POST /admins/suppliers/{supplier}/connectivityPlans​

Create Plan

Request:​

Updated LORAWAN connectivity:

  • Deprecated property managedCustomerNetwork (string)

    Managed Customer Network activation flag

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    Updated LORAWAN connectivity:

    • Deprecated property managedCustomerNetwork (string)

      Managed Customer Network activation flag

      This property must no longer be used: the associated feature is no more available in the product.

GET /admins/suppliers/{supplier}/connectivityPlans/{plan}​

Retrieve Plan

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    Updated LORAWAN connectivity:

    • Deprecated property managedCustomerNetwork (string)

      Managed Customer Network activation flag

      This property must no longer be used: the associated feature is no more available in the product.

PUT /admins/suppliers/{supplier}/connectivityPlans/{plan}​

Update Plan

Request:​

Updated LORAWAN connectivity:

  • Deprecated property managedCustomerNetwork (string)

    Managed Customer Network activation flag

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    Updated LORAWAN connectivity:

    • Deprecated property managedCustomerNetwork (string)

      Managed Customer Network activation flag

      This property must no longer be used: the associated feature is no more available in the product.

Release 7.0​

RDTP-15150​

What's Changed​

GET /admins/suppliers/{supplier}/helpers/hsmGroups​

Retrieve HSM Groups

Parameters:​

Added: hasCellularMasterKeys in query

Only return HSM groups having cellular master keys

Release 6.1​

RDTP-2523​

What's Changed​

GET /admins/suppliers/{supplier}/connectivityPlans​

Retrieve ConnectivityPlans

Parameters:​

Added: deleted in query

Connectivity Plan deletion flag. When specified, only the Connectivity Plan matching the deletion flag are returned.

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (array)

    Changed items (object):

    • Added property deleted (boolean)

      TRUE if the Connectivity Plan is flagged for subsequent deletion: it is automatically deleted as soon as all referring resources are deleted.

RDTP-8676​

What's Changed​

POST /admins/suppliers/{supplier}/connectivityPlans​

Create Plan

Request:​

Updated LORAWAN connectivity:

  • Changed property adrVersion (integer)

    ADR algorithm version:

    • 2: SNR based ADR optimization algorithm (ADRv2)
    • 3: PER based ADR optimization algorithm (ADRv3)

    ADRv2 is DEPRECATED:

    • Only ADRv3 is allowed on Connectivity Plan creation.
    • Existing Connectivity Plans configured in ADRv2 can still use ADRv2 or can be updated to ADRv3.
    • Existing Connectivity Plans configured in ADRv3 can no more be updated to ADRv2.

    As a consequence, the value 2 is only allowed in PUT request if the current value is 2. Otherwise only the value 3 is allowed.

PUT /admins/suppliers/{supplier}/connectivityPlans/{plan}​

Update Plan

Request:​

Updated LORAWAN connectivity:

  • Changed property adrVersion (integer)

    ADR algorithm version:

    • 2: SNR based ADR optimization algorithm (ADRv2)
    • 3: PER based ADR optimization algorithm (ADRv3)

    ADRv2 is DEPRECATED:

    • Only ADRv3 is allowed on Connectivity Plan creation.
    • Existing Connectivity Plans configured in ADRv2 can still use ADRv2 or can be updated to ADRv3.
    • Existing Connectivity Plans configured in ADRv3 can no more be updated to ADRv2.

    As a consequence, the value 2 is only allowed in PUT request if the current value is 2. Otherwise only the value 3 is allowed.

Release 6.0​

No change

Release 5.2.2​

RDTP-2818​

What's New​

GET /suppliers/{supplier}/networkPartners​

Retrieve NetworkPartners

What's Changed​

POST /suppliers/{supplier}/connectivityPlans​

Create Plan

Request:​

Updated LORAWAN connectivity:

  • Added property npAccessControlType (string)

    Network Partner access control type:

    • 'NONE': no access control
    • 'WHITELIST': Whitelist access control
    • 'BLACKLIST': Blacklist access control

    Enum values:

    • NONE
    • WHITELIST
    • BLACKLIST

  • Added property npAccessControlList (array)

    List of whitelisted or blacklisted Network Partners:

    • If npAccessControlType is 'WHITELIST': List of whitelisted Network Partners
    • If npAccessControlType is 'BLACKLIST': List of blacklisted Network Partners

    Items (object):

    • Property ID (string)

      Network Partner ID

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    Updated LORAWAN connectivity:

    • Added property npAccessControlType (string)

      Network Partner access control type:

      • 'NONE': no access control
      • 'WHITELIST': Whitelist access control
      • 'BLACKLIST': Blacklist access control

      Enum values:

      • NONE
      • WHITELIST
      • BLACKLIST

    • Added property npAccessControlList (array)

      List of whitelisted or blacklisted Network Partners:

      • If npAccessControlType is 'WHITELIST': List of whitelisted Network Partners
      • If npAccessControlType is 'BLACKLIST': List of blacklisted Network Partners

      Items (object):

      • Property ID (string)

        Network Partner ID

      • Property state (string)

        Network Partner state

        Enum values:

        • ACTIVE
        • SUSPENDED
        • DEACTIVATED

      • Property type (string)

        Network Partner type

        Enum values:

        • SUPPLIER
        • SUBSCRIBER
GET /suppliers/{supplier}/connectivityPlans/{plan}​

Retrieve Plan

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    Updated LORAWAN connectivity:

    • Added property npAccessControlType (string)

      Network Partner access control type:

      • 'NONE': no access control
      • 'WHITELIST': Whitelist access control
      • 'BLACKLIST': Blacklist access control

      Enum values:

      • NONE
      • WHITELIST
      • BLACKLIST

    • Added property npAccessControlList (array)

      List of whitelisted or blacklisted Network Partners:

      • If npAccessControlType is 'WHITELIST': List of whitelisted Network Partners
      • If npAccessControlType is 'BLACKLIST': List of blacklisted Network Partners

      Items (object):

      • Property ID (string)

        Network Partner ID

      • Property state (string)

        Network Partner state

        Enum values:

        • ACTIVE
        • SUSPENDED
        • DEACTIVATED

      • Property type (string)

        Network Partner type

        Enum values:

        • SUPPLIER
        • SUBSCRIBER
PUT /suppliers/{supplier}/connectivityPlans/{plan}​

Update Plan

Request:​

Updated LORAWAN connectivity:

  • Added property npAccessControlType (string)

    Network Partner access control type:

    • 'NONE': no access control
    • 'WHITELIST': Whitelist access control
    • 'BLACKLIST': Blacklist access control

    Enum values:

    • NONE
    • WHITELIST
    • BLACKLIST

  • Added property npAccessControlList (array)

    List of whitelisted or blacklisted Network Partners:

    • If npAccessControlType is 'WHITELIST': List of whitelisted Network Partners
    • If npAccessControlType is 'BLACKLIST': List of blacklisted Network Partners

    Items (object):

    • Property ID (string)

      Network Partner ID

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    Updated LORAWAN connectivity:

    • Added property npAccessControlType (string)

      Network Partner access control type:

      • 'NONE': no access control
      • 'WHITELIST': Whitelist access control
      • 'BLACKLIST': Blacklist access control

      Enum values:

      • NONE
      • WHITELIST
      • BLACKLIST

    • Added property npAccessControlList (array)

      List of whitelisted or blacklisted Network Partners:

      • If npAccessControlType is 'WHITELIST': List of whitelisted Network Partners
      • If npAccessControlType is 'BLACKLIST': List of blacklisted Network Partners

      Items (object):

      • Property ID (string)

        Network Partner ID

      • Property state (string)

        Network Partner state

        Enum values:

        • ACTIVE
        • SUSPENDED
        • DEACTIVATED

      • Property type (string)

        Network Partner type

        Enum values:

        • SUPPLIER
        • SUBSCRIBER

RDTP-7723​

What's New​

GET /admins/suppliers/{supplier}/helpers/publicExchangeKey​

Retrieve Public Exchange Keys

What's Deleted​

POST /admins/suppliers/{supplier}/sims​

Create SIM card

PUT /admins/suppliers/{supplier}/sims/{sim}​

Update SIM card

What's Changed​

GET /admins/suppliers/{supplier}/helpers/hsmGroups​

Retrieve HSM Groups

Return Type:​

Changed response : 200 OK

Successful RETRIEVE

  • Changed property data (array)

    Changed items (object):

    • Added property hsmExchangeKeyVersion (string)

      HSM Exchange Key version

POST /admins/suppliers/{supplier}/sims/import​

Import SIM cards

Request:​

The SIM cards importation CSV file is updated:

ColumnDefinitionCardinality
C

Secret key of the SIM card (Ki)
Supported encoding modes:

  • Clear text (hexadecimal encoding)
  • Encrypted with Exchange Key (RSA) version specified in column E (base64 encoding)
Mandatory
DHSM group IDOptional
EHSM Exchange Key (RSA) version used to encrypt KiOptional
GET /admins/suppliers/{supplier}/sims/{sim}​

Retrieve SIM card

Return Type:​

Changed response : 200 OK

Successful CREATE, UPDATE or RETRIEVE

  • Changed property data (object)

    New required properties:

    • imsi

    • Added property hsmGroupID (string)

      ID of HSM group used to encrypt the Ki

RDTP-4265 / RDTP-5105​

What's Changed​

POST /suppliers/{supplier}/connectivityPlans​

Create Plan

Request:​
  • Deprecated property multicastRetransmitTimer (integer)

    Delay between two multicast retransmissions burst (in seconds)

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    • Deprecated property multicastRetransmitTimer (integer)

      Delay between two multicast retransmissions burst (in seconds)

GET /suppliers/{supplier}/connectivityPlans/{plan}​

Retrieve Plan

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    • Deprecated property multicastRetransmitTimer (integer)

      Delay between two multicast retransmissions burst (in seconds)

PUT /suppliers/{supplier}/connectivityPlans/{plan}​

Update Plan

Request:​
  • Deprecated property multicastRetransmitTimer (integer)

    Delay between two multicast retransmissions burst (in seconds)

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    • Deprecated property multicastRetransmitTimer (integer)

      Delay between two multicast retransmissions burst (in seconds)

RDTP-5460​

What's New​

GET /suppliers/{supplier}/sims​

Retrieve SIM cards

POST /suppliers/{supplier}/sims​

Create SIM card

POST /suppliers/{supplier}/sims/import​

Import SIM cards

GET /suppliers/{supplier}/sims/{sim}​

Retrieve SIM card

PUT /suppliers/{supplier}/sims/{sim}​

Update SIM card

DELETE /suppliers/{supplier}/sims/{sim}​

Delete SIM card

What's Changed​

GET /admins/suppliers/{supplier}​

Retrieve Supplier

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    • Added property epcProvisioningMode (string)

      EPC connector provisioning mode. SIM cards provisioning is only supported if EPC connector provisioning mode is 'HSS_SPR'.

      Enum values:

      • DEACTIVATED
      • SPR
      • HSS_SPR

Release 5.1​

RDTP-4623​

What's Changed​

POST /admins/suppliers/{supplier}/connectivityPlans​

Create Plan

Request:​

Updated LORAWAN connectivity:

  • Changed property adrVersion (integer)

    ADR algorithm version:

    • 2: SNR based ADR optimization algorithm
    • 3: PER based ADR optimization algorithm

    Changed default value:

    • 3
PUT /admins/suppliers/{supplier}/connectivityPlans/{plan}​

Update Plan

Request:​

Updated LORAWAN connectivity:

  • Changed property adrVersion (integer)

    ADR algorithm version:

    • 2: SNR based ADR optimization algorithm
    • 3: PER based ADR optimization algorithm

    Changed default value:

    • 3

Release 5.0.1​

General​

What's Changed​

GET /admins/suppliers/{supplier}/connectivityPlans​

Retrieve ConnectivityPlans

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    • Added property communicationType (string)

      Communication type of Connectivity Plan

POST /admins/suppliers/{supplier}/connectivityPlans​

Create Plan

Request:​

  • Added property multicastRetransmitTimer (integer)

    Delay between two multicast retransmissions burst (in seconds)

  • Added property multicastInterDelay (integer)

    Transmission delay between different LRRs (in seconds)

  • Added property multicastCollisionAvoidanceDistance (integer)

    Minimum distance between two LRRs to avoid transmission collision (in meters)

  • Added property multicastMaxLrrCells (integer)

    Maximum number of LRRs associated with the multicast group

  • Added property communicationType (string)

    Communication type of Connectivity Plan. MULTICAST is available only for LORAWAN connectivity.

  • LoRaWAN connectivity

    • Changed property nwGeolocAlgo (string)

      Network geolocation algorithm:

      • TDOA: The calculation uses the time of arrival and received signal characteristics of uplink frames at the receiving gateways.
      • RSSI: The calculation uses the received signal strength of uplink frames at the receiving gateways.
      • BOTH: The calculation combines both TDOA and RSSI algorithms: RSSI algorithm is used if TDOA algorithm does not provide a valid geolocation.

    • Added property managedCustomerNetwork (string)

      Managed Customer Network activation flag

    • Added property managedCustomerNetwork (string)

      Managed Customer Network activation flag

  • Cellular connectivity

    • Added property allowMessageMode (integer)

      Enable the Device to send message mode packets

      default: 1

    • Added property allowDirectIPMode (integer)

      Enable the Device to send direct IP mode traffic

      default: 0

    • Added property maximumBandwidthUp (integer)

      Maximum allowed bandwidth in kbps for the direct IP mode traffic sent by the Device

      0 means no bandwidth up enforcement

    • Added property maximumBandwidthDown (integer)

      Maximum allowed bandwidth in kbps for the direct IP mode traffic received by the Device

      0 means no bandwidth up enforcement

    • Added property microflowMinimalDuration (integer)

      Minimal duration of a microflow event in seconds.

      Acceptable range is from 10 seconds to 1 minute

    • Added property microflowMaximalDuration (integer)

      Maximal duration of a microflow event in seconds.

      Acceptable range is from 1 minute to 1 hour

    • Added property microflowMaximalVolume (integer)

      Maximal volume of the uplink and downlink direct IP mode traffic in bytes to close a microflow event.

      Acceptable range is from 50 KB to 10 MB

Return Type:​

Changed response : 201 Created

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    • Added property multicastRetransmitTimer (integer)

      Delay between two multicast retransmissions burst (in seconds)

    • Added property multicastInterDelay (integer)

      Transmission delay between different LRRs (in seconds)

    • Added property multicastCollisionAvoidanceDistance (integer)

      Minimum distance between two LRRs to avoid transmission collision (in meters)

    • Added property multicastMaxLrrCells (integer)

      Maximum number of LRRs associated with the multicast group

    • Added property communicationType (string)

      Communication type of Connectivity Plan. MULTICAST is available only for LORAWAN connectivity.

    • Added property multicastMaxTransmit (integer)

      Maximum number of times the LRC will attempts to transmit frames to LRRs which could not broadcast it

    • LoRaWAN connectivity

      • Changed property nwGeolocAlgo (string)

        Network geolocation algorithm:

        • TDOA: The calculation uses the time of arrival and received signal characteristics of uplink frames at the receiving gateways.
        • RSSI: The calculation uses the received signal strength of uplink frames at the receiving gateways.
        • BOTH: The calculation combines both TDOA and RSSI algorithms: RSSI algorithm is used if TDOA algorithm does not provide a valid geolocation.

      • Added property managedCustomerNetwork (string)

        Managed Customer Network activation flag

    • Cellular connectivity

      • Added property allowMessageMode (integer)

        Enable the Device to send message mode packets

        default: 1

      • Added property allowDirectIPMode (integer)

        Enable the Device to send direct IP mode traffic

        default: 0

      • Added property maximumBandwidthUp (integer)

        Maximum allowed bandwidth in kbps for the direct IP mode traffic sent by the Device

        0 means no bandwidth up enforcement

      • Added property maximumBandwidthDown (integer)

        Maximum allowed bandwidth in kbps for the direct IP mode traffic received by the Device

        0 means no bandwidth up enforcement

      • Added property microflowMinimalDuration (integer)

        Minimal duration of a microflow event in seconds.

        Acceptable range is from 10 seconds to 1 minute

      • Added property microflowMaximalDuration (integer)

        Maximal duration of a microflow event in seconds.

        Acceptable range is from 1 minute to 1 hour

      • Added property microflowMaximalVolume (integer)

        Maximal volume of the uplink and downlink direct IP mode traffic in bytes to close a microflow event.

        Acceptable range is from 50 KB to 10 MB

GET /admins/suppliers/{supplier}/connectivityPlans/{plan}​

Retrieve Plan

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    • Added property multicastRetransmitTimer (integer)

      Delay between two multicast retransmissions burst (in seconds)

    • Added property multicastInterDelay (integer)

      Transmission delay between different LRRs (in seconds)

    • Added property multicastCollisionAvoidanceDistance (integer)

      Minimum distance between two LRRs to avoid transmission collision (in meters)

    • Added property multicastMaxLrrCells (integer)

      Maximum number of LRRs associated with the multicast group

    • Added property communicationType (string)

      Communication type of Connectivity Plan. MULTICAST is available only for LORAWAN connectivity.

    • Added property multicastMaxTransmit (integer)

      Maximum number of times the LRC will attempts to transmit frames to LRRs which could not broadcast it

    • LoRaWAN connectivity

      • Changed property nwGeolocAlgo (string)

        Network geolocation algorithm:

        • TDOA: The calculation uses the time of arrival and received signal characteristics of uplink frames at the receiving gateways.
        • RSSI: The calculation uses the received signal strength of uplink frames at the receiving gateways.
        • BOTH: The calculation combines both TDOA and RSSI algorithms: RSSI algorithm is used if TDOA algorithm does not provide a valid geolocation.

      • Added property managedCustomerNetwork (string)

        Managed Customer Network activation flag

    • Cellular connectivity

      • Added property allowMessageMode (integer)

        Enable the Device to send message mode packets

        default: 1

      • Added property allowDirectIPMode (integer)

        Enable the Device to send direct IP mode traffic

        default: 0

      • Added property maximumBandwidthUp (integer)

        Maximum allowed bandwidth in kbps for the direct IP mode traffic sent by the Device

        0 means no bandwidth up enforcement

      • Added property maximumBandwidthDown (integer)

        Maximum allowed bandwidth in kbps for the direct IP mode traffic received by the Device

        0 means no bandwidth up enforcement

      • Added property microflowMinimalDuration (integer)

        Minimal duration of a microflow event in seconds.

        Acceptable range is from 10 seconds to 1 minute

      • Added property microflowMaximalDuration (integer)

        Maximal duration of a microflow event in seconds.

        Acceptable range is from 1 minute to 1 hour

      • Added property microflowMaximalVolume (integer)

        Maximal volume of the uplink and downlink direct IP mode traffic in bytes to close a microflow event.

        Acceptable range is from 50 KB to 10 MB

PUT /admins/suppliers/{supplier}/connectivityPlans/{plan}​

Update Plan

Request:​

  • Added property multicastRetransmitTimer (integer)

    Delay between two multicast retransmissions burst (in seconds)

  • Added property multicastInterDelay (integer)

    Transmission delay between different LRRs (in seconds)

  • Added property multicastCollisionAvoidanceDistance (integer)

    Minimum distance between two LRRs to avoid transmission collision (in meters)

  • Added property multicastMaxLrrCells (integer)

    Maximum number of LRRs associated with the multicast group

  • Added property multicastMaxTransmit (integer)

    Maximum number of times the LRC will attempts to transmit frames to LRRs which could not broadcast it

  • LoRaWAN connectivity

    • Changed property nwGeolocAlgo (string)

      Network geolocation algorithm:

      • TDOA: The calculation uses the time of arrival and received signal characteristics of uplink frames at the receiving gateways.
      • RSSI: The calculation uses the received signal strength of uplink frames at the receiving gateways.
      • BOTH: The calculation combines both TDOA and RSSI algorithms: RSSI algorithm is used if TDOA algorithm does not provide a valid geolocation.

    • Added property managedCustomerNetwork (string)

      Managed Customer Network activation flag

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property data (object)

    • Added property multicastRetransmitTimer (integer)

      Delay between two multicast retransmissions burst (in seconds)

    • Added property multicastInterDelay (integer)

      Transmission delay between different LRRs (in seconds)

    • Added property multicastCollisionAvoidanceDistance (integer)

      Minimum distance between two LRRs to avoid transmission collision (in meters)

    • Added property multicastMaxLrrCells (integer)

      Maximum number of LRRs associated with the multicast group

    • Added property communicationType (string)

      Communication type of Connectivity Plan. MULTICAST is available only for LORAWAN connectivity.

    • Added property multicastMaxTransmit (integer)

      Maximum number of times the LRC will attempts to transmit frames to LRRs which could not broadcast it

    • LoRaWAN connectivity

      • Changed property nwGeolocAlgo (string)

        Network geolocation algorithm:

        • TDOA: The calculation uses the time of arrival and received signal characteristics of uplink frames at the receiving gateways.
        • RSSI: The calculation uses the received signal strength of uplink frames at the receiving gateways.
        • BOTH: The calculation combines both TDOA and RSSI algorithms: RSSI algorithm is used if TDOA algorithm does not provide a valid geolocation.

      • Added property managedCustomerNetwork (string)

        Managed Customer Network activation flag

    • Cellular connectivity

      • Added property allowMessageMode (integer)

        Enable the Device to send message mode packets

        default: 1

      • Added property allowDirectIPMode (integer)

        Enable the Device to send direct IP mode traffic

        default: 0

      • Added property maximumBandwidthUp (integer)

        Maximum allowed bandwidth in kbps for the direct IP mode traffic sent by the Device

        0 means no bandwidth up enforcement

      • Added property maximumBandwidthDown (integer)

        Maximum allowed bandwidth in kbps for the direct IP mode traffic received by the Device

        0 means no bandwidth up enforcement

      • Added property microflowMinimalDuration (integer)

        Minimal duration of a microflow event in seconds.

        Acceptable range is from 10 seconds to 1 minute

      • Added property microflowMaximalDuration (integer)

        Maximal duration of a microflow event in seconds.

        Acceptable range is from 1 minute to 1 hour

      • Added property microflowMaximalVolume (integer)

        Maximal volume of the uplink and downlink direct IP mode traffic in bytes to close a microflow event.

        Acceptable range is from 50 KB to 10 MB

Release 4.2​

NFR880​

Following web services are updated:

  • C /suppliers/\{supplier\}/connectivityPlans
  • RU /suppliers/\{supplier\}/connectivityPlans/\{plan\}
Attribute nameXSD typeCreateUpdateResp.Description
minRx1Delay → NEWunsignedIntOOOOptional minimal RX1 delay. When defined, the value has precedence on the RX1 value defined in the RF Region.

Release 4.1.2​

NFR729​

Following web services are updated:

  • C /suppliers/\{supplier\}/connectivityPlans
  • RU /suppliers/\{supplier\}/connectivityPlans/\{plan\}
Attribute nameXSD typeCreateUpdateResp.Description
uplinkProcessing → NEWunsignedIntOOOConfigures the UL processing on the LRC: 0: Synchronous processing > 0 : Asynchronous processing as described in NFR 729

NFR883​

Following web services are updated:

  • C /suppliers/\{supplier\}/connectivityPlans
  • RU /suppliers/\{supplier\}/connectivityPlans/\{plan\}
Attribute nameXSD typeCreateUpdateResp.Description
forceChannelMask → UPDATEDStringOOOForce channel mask: - 16 bits (hexadecimal) for eu863, cn779, eu433, as923, kr920, or gsm894 - 64 bits or 72 bits (hexadecimal) for us902 or au915 - 96 bits (hexadecimal) for cn470

Release 4.1.1​

NFR809​

Following web services are updated:

  • C /suppliers/\{supplier\}/connectivityPlans
  • RU /suppliers/\{supplier\}/connectivityPlans/\{plan\}
Attribute nameXSD typeCreateUpdateResp.Description
raAllowed → NEWunsignedIntOOMRoaming activation allowed: 0: FALSE 1: TRUE
prAllowed → NEWunsignedIntOOMPassive roaming allowed: 0: FALSE 1: TRUE
hrAllowed → NEWunsignedIntOOMHandover roaming allowed: 0: FALSE 1: TRUE

Release 4.1​

NFR725​

Following web services are updated:

  • C /suppliers/\{supplier\}/connectivityPlans
  • RU /suppliers/\{supplier\}/connectivityPlans/\{plan\}
Attribute nameXSD typeCreateUpdateResp.Description
thingParkKafkaRouting → NEWBooleanOOMAllow routing to the ThingPark Kafka cluster.Default value: false

NFR743​

Following web services are updated:

  • C /suppliers/\{supplier\}/connectivityPlans
  • RU /suppliers/\{supplier\}/connectivityPlans/\{plan\}
Attribute nameXSD typeCreateUpdateResp.Description
allowClassB → NEWbooleanOOMFlag to signal that the network will honor requests to switch to LoraWAN class B.

NFR792​

Following web services are updated:

  • C /suppliers/\{supplier\}/connectivityPlans
  • RU /suppliers/\{supplier\}/connectivityPlans/\{plan\}
Attribute nameXSD typeCreateUpdateResp.Description
adrVersion → NEWunsignedIntOOMADR algorithm version: SNR based ADR optimization algorithm (2), PER based ADR optimization algorithm (3)Default: 2
Last updated on
Copyright © 2025 Actility
On this page