PUT api/SIMs

Update a SIM

Request Information

URI Parameters

None.

Body Parameters

The SIM to be updated

Update_SIM
NameDescriptionTypeAdditional information
ID

SIM ID

integer

None.

SerialNumber

Serial Number

string

None.

PhoneNumber

Phone number

string

None.

Plan

SIM card's Plan

string

None.

State

The current State of the SIM Card

CardState

None.

CommsInterfaceID

Integer ID of the Comms Interface this SIM is in

integer

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "ID": 1,
  "SerialNumber": "sample string 2",
  "PhoneNumber": "sample string 3",
  "Plan": "sample string 4",
  "State": 0,
  "CommsInterfaceID": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the updated SIM and messages

GetSIMResponse
NameDescriptionTypeAdditional information
SIMs

Array of SIMs

Collection of SIMStruct

None.

Messages

Array of messages

Collection of Message

None.

ServerInformation

Relevant information regarding the Server

ServerInformation

None.

VersionInformation

Relevant information regarding the API's version

VersionInformation

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "SIMs": [
    {
      "ID": 1,
      "SerialNumber": "sample string 2",
      "PhoneNumber": "sample string 3",
      "Plan": "sample string 4",
      "State": 0,
      "CommsInterfaceID": 1
    },
    {
      "ID": 1,
      "SerialNumber": "sample string 2",
      "PhoneNumber": "sample string 3",
      "Plan": "sample string 4",
      "State": 0,
      "CommsInterfaceID": 1
    }
  ],
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:25:12.1465264+10:00",
    "BuildDateUTC": "2025-11-09T21:25:12.1465264+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}