Skip to main content

Get SIM card action details

GET 

/sim_card_actions/:id

This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.

Request

Path Parameters

    id uuidrequired

    Identifies the resource.

Responses

200: Successful Response

Schema

    data

    object

    This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.

    id uuid

    Identifies the resource.

    record_type string
    sim_card_id uuid

    The related SIM card identifier.

    action_type string

    Possible values: [enable, enable_standby_sim_card, disable, set_standby]

    The operation type. It can be one of the following:

    • enable - move the SIM card to the enabled status
    • enable_standby_sim_card - move a SIM card previously on the standby status to the enabled status after it consumes data.
    • disable - move the SIM card to the disabled status
    • set_standby - move the SIM card to the standby status

    status

    object

    value string

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

    The current status of the SIM card action.

    reason string

    It describes why the SIM card action is in the current status. This will be null for self-explanatory statuses, such as in-progress and completed but will include further information on statuses like interrupted and failed.

    settings objectnullable

    A JSON object representation of the action params.

    created_at CreatedAt

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

    updated_at UpdatedAt

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

default: Unexpected error

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...