POST /Japi/Tigrillo/getSIMStateOptions

Returns the state options you can apply to the current SIM, based on the current state:

  • If the SIM is active (provisioned), then you can suspend or terminate (deprovision) it.
  • If the SIM is suspended, then you can reactivate or deprovision it.
  • If the SIM is unprovisioned (terminated), then you can reactivate it.

Eseye SIMs have the following lifecycle in the API:

For more information, see Understanding the SIM lifecycle.

The Tigrillo API fetches the following statuses:

  • null (default) – returns all values, regardless of state
  • available
  • pendingProvision
  • provisioned
  • suspended
  • pendingDeprovision
  • unprovisioned

Authentication

  • User required to login

Headers

For information about headers, see Configuring headers.

Request Body application/json

Schema

Object name Type Description Required?
ICCID 20 char string The current SIM ICCID

Example

Copy
Body raw JSON
{
"ICCID" : "8944538523016999555"
}

Responses application/json

Schema

JSON key Description
status

The array, containing details about the request status.
status

"OK" – the request processed successfully

"ERR" – the request failed
errorCode

"" – the request processed successfully

"<ErrorCodeNumber>" – the request failed because of this specific error.

For more information, see Troubleshooting errors: Tigrillo API.
errorMessage

"" – the request processed successfully

"<ErrorCodeMessage>" – displays an explanation of the error if the request failed.

For more information, see Troubleshooting errors: Tigrillo API.
stateOptions

The array, displaying optional states.

If suspended and terminate are both returned, the SIM has a provisioned status.

If active and terminate are both returned, the SIM has a suspended status.
ID

Either:

suspend – you can suspend the SIM card. If suspended, the SIM will continue connecting to the network and service charges will continue, but you cannot use the SIM. Suspension is instant and you can reverse it.

terminate– you can terminate the SIM card. If terminated (unprovisioned), the SIM will stop connecting to the network. Service charges will stop unless the SIM is in contract, in which case the customer is liable for the rest of the service charges up until the end date of the contract. Termination is not instant – Eseye must verify the termination.In some instances, you can reprovision a terminated SIM. For more information, see POST /Japi/Tigrillo/activateSIMs. Allow two hours for the reprovisioning process to complete.

active – you can reactivate the SIM card. If activated, the SIM card will start connecting to the network and service charges could apply. You can reverse activation.

reason – indicates that you cannot change the SIM card state, and explains why.
title A description of the state option.

Example

Copy
JSON
{
    "status": {
        "status": "OK",
        "errorCode": "",
        "errorMessage": ""
    },
    "stateOptions": [
        {
            "ID": "suspend",
            "title": "Suspend SIM"
        },
        {
            "ID": "terminate",
            "title": "Terminate the SIM"
        }
    ]
}

Where to next?

Related resources