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
Identifies the resource.
Responses
200: Successful Response
- application/json
- Schema
- Example (from schema)
Schema
enable
- move the SIM card to theenabled
statusenable_standby_sim_card
- move a SIM card previously on thestandby
status to theenabled
status after it consumes data.disable
- move the SIM card to thedisabled
statusset_standby
- move the SIM card to thestandby
status
data
object
This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.
Identifies the resource.
The related SIM card identifier.
Possible values: [enable
, enable_standby_sim_card
, disable
, set_standby
]
The operation type. It can be one of the following:
status
object
Possible values: [in-progress
, completed
, failed
, interrupted
]
The current status of the SIM card action.
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
.
A JSON object representation of the action params.
ISO 8601 formatted date-time indicating when the resource was created.
ISO 8601 formatted date-time indicating when the resource was updated.
This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.
{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_action",
"sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"action_type": "enable",
"status": {
"value": "completed",
"reason": "The data limit was exceeded."
},
"settings": {},
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}