PATCH v1/accounts/{foreignaccountkey}/hardware/sims/{rawcli}

Update a SIM device on the ApiAccount. This is primarily used to changes the SIM's state on the radio network.<br/><br/> Note that is endpoint returns a 202 code as the request is queued. A status url is returned in the return meta-data that can be used to poll the status of this request.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
foreignaccountkey

The Api Account to create the SIM on

string

Required

rawcli

string

Required

Body Parameters

DeltaOfSIMCard

None.

Request Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<DeltaOfSIMCard7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASApi" />

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Delta`1'.

Response Information

Resource Description

PBPRReturnOfSIMCard
NameDescriptionTypeAdditional information
Data

SIMCard

None.

Success

Gets the success status of the API call

boolean

None.

Meta

Gets the optional meta-data

Dictionary of string [key] and string [value]

None.

Code

Get the http code of the API call e.g. 200, 202, 409

integer

None.

ErrorCode

Get the failure error code of the API call. This is available if Success is false

integer

None.

ErrorSubCode

Gets the error sub code if available

integer

None.

ErrorDescription

Gets a textual description of the error

string

None.

StatusUrl

Gets the status url for any ACCEPTed API commands. Any command (POST,DELETE,PATCh,PUT) to the API usually returns a 202 response code. The status of the command can be queried using the URL provided

string

None.

ContinuationToken

Gets the token to be used for paged queries

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Meta": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Code": 2,
  "ErrorCode": 3,
  "Data": {
    "CLI": "sample string 1",
    "SIMNumber": "sample string 2",
    "Description": "sample string 3",
    "InventoryRef": "sample string 4",
    "State": 0,
    "Version": 5,
    "ActorStatus": 0,
    "ForeignAttributes": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Tariff": "sample string 6",
    "Bundle": "sample string 7",
    "Operator": "sample string 8",
    "Hints": {
      "BillingCycleDay": 1,
      "EmailContact": "sample string 2",
      "TenantId": "sample string 3"
    },
    "NetworkStatus": 0,
    "Created": "2018-12-14T08:00:55.4120234+00:00",
    "SOC": "sample string 10",
    "InternalSOC": "sample string 11",
    "PurchaseOrder": "sample string 12",
    "Provider": "sample string 13",
    "ProviderTariff": "sample string 14",
    "ProviderPrice": "sample string 15",
    "ProviderStartDate": "2018-12-14T08:00:55.4120234+00:00"
  },
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "5PKjvvbnyradrvD4%2BbOllw%3D%3D"
}

application/xml, text/xml

Sample:
<PBPRReturnOfSIMCard7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>5PKjvvbnyradrvD4%2BbOllw%3D%3D</ContinuationToken>
  <ErrorCode>3</ErrorCode>
  <ErrorDescription>sample string 5</ErrorDescription>
  <ErrorSubCode>4</ErrorSubCode>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <StatusUrl>sample string 6</StatusUrl>
  <Success>true</Success>
  <Data>
    <ActorStatus>stable</ActorStatus>
    <Bundle>sample string 7</Bundle>
    <CLI>sample string 1</CLI>
    <Created>2018-12-14T08:00:55.4120234+00:00</Created>
    <Description>sample string 3</Description>
    <ForeignAttributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </ForeignAttributes>
    <Hints>
      <BillingCycleDay>1</BillingCycleDay>
      <EmailContact>sample string 2</EmailContact>
      <TenantId>sample string 3</TenantId>
    </Hints>
    <InternalSOC>sample string 11</InternalSOC>
    <InventoryRef>sample string 4</InventoryRef>
    <NetworkStatus>disconnected</NetworkStatus>
    <Operator>sample string 8</Operator>
    <Provider>sample string 13</Provider>
    <ProviderPrice>sample string 15</ProviderPrice>
    <ProviderStartDate>2018-12-14T08:00:55.4120234+00:00</ProviderStartDate>
    <ProviderTariff>sample string 14</ProviderTariff>
    <PurchaseOrder>sample string 12</PurchaseOrder>
    <SIMNumber>sample string 2</SIMNumber>
    <SOC>sample string 10</SOC>
    <State>notactivated</State>
    <Tariff>sample string 6</Tariff>
    <Version>5</Version>
  </Data>
</PBPRReturnOfSIMCard7NMnQmOk>