GET api/v1/bots/sparkbots/{id}/Sims

Gets the sims associated with the particle bot.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of SimDto
NameDescriptionTypeAdditional information
SimId

Particle Sim Id. Links to the SparkDevice Last IccId

string

None.

BaseCountryCode

BaseCountryCode

string

None.

BaseMonthlyRate

BaseMonthlyRate

decimal number

None.

OverageMonthlyRate

Overage Monthly Rate

decimal number

None.

FirstActivatedOn

FirstActivatedOn

date

None.

Imsi

Imsi

string

None.

LastActivatedOn

LastActivatedOn

date

None.

LimitMb

LimitMb

decimal number

None.

Status

Status

string

None.

Carrier

Carrier

string

None.

Usage

Collection of SimUsageDto

None.

LastStatusChangeAction

LastStatusChangeAction

string

None.

LastStatusChangeActionError

LastStatusChangeActionError

string

None.

LastUsage

Helper - the last recorded usage.

SimUsageDto

None.

LastUpdated

date

None.

DateAdded

date

None.

EstimatedMonthUsage

Estimated data usage to the end of the month.

decimal number

None.

Response Formats

application/json, text/json, application/senml+json

Sample:
[
  {
    "SimId": "sample string 1",
    "BaseCountryCode": "sample string 2",
    "BaseMonthlyRate": 3.1,
    "OverageMonthlyRate": 4.1,
    "FirstActivatedOn": "2019-08-17T11:53:08.5770294+00:00",
    "Imsi": "sample string 6",
    "LastActivatedOn": "2019-08-17T11:53:08.5770294+00:00",
    "LimitMb": 8.1,
    "Status": "sample string 9",
    "Carrier": "sample string 10",
    "Usage": [
      {
        "Date": "2019-08-17T11:53:08.5770294+00:00",
        "UsedMb": 2.1,
        "CumulativeUsageMb": 3.1
      },
      {
        "Date": "2019-08-17T11:53:08.5770294+00:00",
        "UsedMb": 2.1,
        "CumulativeUsageMb": 3.1
      }
    ],
    "LastStatusChangeAction": "sample string 11",
    "LastStatusChangeActionError": "sample string 12",
    "LastUsage": {
      "Date": "2019-08-17T11:53:08.5770294+00:00",
      "UsedMb": 2.1,
      "CumulativeUsageMb": 3.1
    },
    "LastUpdated": "2019-08-17T11:53:08.5770294+00:00",
    "DateAdded": "2019-08-17T11:53:08.5770294+00:00",
    "EstimatedMonthUsage": 15.1
  },
  {
    "SimId": "sample string 1",
    "BaseCountryCode": "sample string 2",
    "BaseMonthlyRate": 3.1,
    "OverageMonthlyRate": 4.1,
    "FirstActivatedOn": "2019-08-17T11:53:08.5770294+00:00",
    "Imsi": "sample string 6",
    "LastActivatedOn": "2019-08-17T11:53:08.5770294+00:00",
    "LimitMb": 8.1,
    "Status": "sample string 9",
    "Carrier": "sample string 10",
    "Usage": [
      {
        "Date": "2019-08-17T11:53:08.5770294+00:00",
        "UsedMb": 2.1,
        "CumulativeUsageMb": 3.1
      },
      {
        "Date": "2019-08-17T11:53:08.5770294+00:00",
        "UsedMb": 2.1,
        "CumulativeUsageMb": 3.1
      }
    ],
    "LastStatusChangeAction": "sample string 11",
    "LastStatusChangeActionError": "sample string 12",
    "LastUsage": {
      "Date": "2019-08-17T11:53:08.5770294+00:00",
      "UsedMb": 2.1,
      "CumulativeUsageMb": 3.1
    },
    "LastUpdated": "2019-08-17T11:53:08.5770294+00:00",
    "DateAdded": "2019-08-17T11:53:08.5770294+00:00",
    "EstimatedMonthUsage": 15.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfSimDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.SparkBot">
  <SimDto>
    <BaseCountryCode>sample string 2</BaseCountryCode>
    <BaseMonthlyRate>3.1</BaseMonthlyRate>
    <Carrier>sample string 10</Carrier>
    <DateAdded>2019-08-17T11:53:08.5770294+00:00</DateAdded>
    <EstimatedMonthUsage>15.1</EstimatedMonthUsage>
    <FirstActivatedOn>2019-08-17T11:53:08.5770294+00:00</FirstActivatedOn>
    <Imsi>sample string 6</Imsi>
    <LastActivatedOn>2019-08-17T11:53:08.5770294+00:00</LastActivatedOn>
    <LastStatusChangeAction>sample string 11</LastStatusChangeAction>
    <LastStatusChangeActionError>sample string 12</LastStatusChangeActionError>
    <LastUpdated>2019-08-17T11:53:08.5770294+00:00</LastUpdated>
    <LastUsage>
      <CumulativeUsageMb>3.1</CumulativeUsageMb>
      <Date>2019-08-17T11:53:08.5770294+00:00</Date>
      <UsedMb>2.1</UsedMb>
    </LastUsage>
    <LimitMb>8.1</LimitMb>
    <OverageMonthlyRate>4.1</OverageMonthlyRate>
    <SimId>sample string 1</SimId>
    <Status>sample string 9</Status>
    <Usage>
      <SimUsageDto>
        <CumulativeUsageMb>3.1</CumulativeUsageMb>
        <Date>2019-08-17T11:53:08.5770294+00:00</Date>
        <UsedMb>2.1</UsedMb>
      </SimUsageDto>
      <SimUsageDto>
        <CumulativeUsageMb>3.1</CumulativeUsageMb>
        <Date>2019-08-17T11:53:08.5770294+00:00</Date>
        <UsedMb>2.1</UsedMb>
      </SimUsageDto>
    </Usage>
  </SimDto>
  <SimDto>
    <BaseCountryCode>sample string 2</BaseCountryCode>
    <BaseMonthlyRate>3.1</BaseMonthlyRate>
    <Carrier>sample string 10</Carrier>
    <DateAdded>2019-08-17T11:53:08.5770294+00:00</DateAdded>
    <EstimatedMonthUsage>15.1</EstimatedMonthUsage>
    <FirstActivatedOn>2019-08-17T11:53:08.5770294+00:00</FirstActivatedOn>
    <Imsi>sample string 6</Imsi>
    <LastActivatedOn>2019-08-17T11:53:08.5770294+00:00</LastActivatedOn>
    <LastStatusChangeAction>sample string 11</LastStatusChangeAction>
    <LastStatusChangeActionError>sample string 12</LastStatusChangeActionError>
    <LastUpdated>2019-08-17T11:53:08.5770294+00:00</LastUpdated>
    <LastUsage>
      <CumulativeUsageMb>3.1</CumulativeUsageMb>
      <Date>2019-08-17T11:53:08.5770294+00:00</Date>
      <UsedMb>2.1</UsedMb>
    </LastUsage>
    <LimitMb>8.1</LimitMb>
    <OverageMonthlyRate>4.1</OverageMonthlyRate>
    <SimId>sample string 1</SimId>
    <Status>sample string 9</Status>
    <Usage>
      <SimUsageDto>
        <CumulativeUsageMb>3.1</CumulativeUsageMb>
        <Date>2019-08-17T11:53:08.5770294+00:00</Date>
        <UsedMb>2.1</UsedMb>
      </SimUsageDto>
      <SimUsageDto>
        <CumulativeUsageMb>3.1</CumulativeUsageMb>
        <Date>2019-08-17T11:53:08.5770294+00:00</Date>
        <UsedMb>2.1</UsedMb>
      </SimUsageDto>
    </Usage>
  </SimDto>
</ArrayOfSimDto>