Skip to main content

Bulk Network Preferences for SIM cards

PUT 

/actions/network_preferences/sim_cards

This API allows dispatching the same operation described for the PUT sim_cards/:sim_card_id/network_preferences API for multiple SIM cards at once.

Although, a SIM card network preference may fail individually under any validation triggered as a consequence of its state. For example, a SIM can't have an in-progress OTA update for applying a Network Preference, so they'll fail when requested in this API. In that scenario, the specific error will be present in the response along with the successful definitions in the "errors" response node.

Request

Body

    sim_card_ids uuid[]

    mobile_network_operators_preferences

    object[]

    A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.

  • Array [

  • mobile_network_operator_id uuid

    The mobile network operator resource identification UUID.

    priority integer

    It determines what is the priority of a specific network operator that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.

  • ]

Responses

202:

Schema

    data

    object[]

    Multi requested SIM cards network preferences.

  • Array [

  • record_type string
    sim_card_id uuid

    mobile_network_operators_preferences

    object[]

    A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.

  • Array [

  • mobile_network_operator_id uuid

    The mobile network operator resource identification UUID.

    mobile_network_operator_name string

    The mobile network operator resource name.

    priority integer

    It determines what is the priority of a specific network operator that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.

  • ]

  • ota_updates

    object[]

  • Array [

  • id uuid

    Identifies the resource.

    record_type string
    sim_card_id uuid

    The identification UUID of the related SIM card resource.

    type string

    Possible values: [sim_card_network_preferences]

    Represents the type of the operation requested. This will relate directly to the source of the request.

    status string

    Possible values: [in-progress, completed, failed]

    settings

    object

    A JSON object representation of the operation. The information present here will relate directly to the source of the OTA request.

    mobile_network_operators_preferences

    object[]

    A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.

  • Array [

  • mobile_network_operator_id uuid

    The mobile network operator resource identification UUID.

    mobile_network_operator_name string

    The mobile network operator resource name.

    priority integer

    It determines what is the priority of a specific network operator that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.

  • ]

  • created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

  • ]

  • created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

  • ]

  • errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

422: Unprocessable entity. Check the 'detail' field in response for details.

Schema

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...