api/v1/pools/{id}/usage

Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/pools/{id}/usage

Summary

Get the usage of a pool this month

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique Id of a pool	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

PoolModel

Name	Description	Type	Additional information
Id		globally unique identifier	None.
Type		string	None.
PoolName		string	None.
Operator		string	None.
Usage		integer	None.
Sims	All SIMs associated with this pool	Collection of SimpleSimModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "ae54b630-edaf-48b9-9ee5-53dac23a02a4",
  "Type": "sample string 2",
  "PoolName": "sample string 3",
  "Operator": "sample string 4",
  "Usage": 1,
  "Sims": [
    {
      "Id": "baafae61-964b-4551-a385-6844f95235a6",
      "MobileNumber": "sample string 2",
      "ICCID": "sample string 3",
      "State": 0,
      "Operator": "sample string 4",
      "CustomerName": "sample string 5",
      "SimTag": "sample string 6",
      "HasBoltons": true,
      "Tariff": "sample string 8",
      "TariffAllowance": 9,
      "AllowanceUsed": 10.1,
      "Allowance": 11,
      "ActivatedDate": "2024-11-21T10:51:24.4845488+00:00"
    },
    {
      "Id": "baafae61-964b-4551-a385-6844f95235a6",
      "MobileNumber": "sample string 2",
      "ICCID": "sample string 3",
      "State": 0,
      "Operator": "sample string 4",
      "CustomerName": "sample string 5",
      "SimTag": "sample string 6",
      "HasBoltons": true,
      "Tariff": "sample string 8",
      "TariffAllowance": 9,
      "AllowanceUsed": 10.1,
      "Allowance": 11,
      "ActivatedDate": "2024-11-21T10:51:24.4845488+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<PoolModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models">
  <Id>ae54b630-edaf-48b9-9ee5-53dac23a02a4</Id>
  <Operator>sample string 4</Operator>
  <PoolName>sample string 3</PoolName>
  <Sims>
    <SimpleSimModel>
      <ActivatedDate>2024-11-21T10:51:24.4845488+00:00</ActivatedDate>
      <Allowance>11</Allowance>
      <AllowanceUsed>10.1</AllowanceUsed>
      <CustomerName>sample string 5</CustomerName>
      <HasBoltons>true</HasBoltons>
      <ICCID>sample string 3</ICCID>
      <Id>baafae61-964b-4551-a385-6844f95235a6</Id>
      <MobileNumber>sample string 2</MobileNumber>
      <Operator>sample string 4</Operator>
      <SimTag>sample string 6</SimTag>
      <State>Active</State>
      <Tariff>sample string 8</Tariff>
      <TariffAllowance>9</TariffAllowance>
    </SimpleSimModel>
    <SimpleSimModel>
      <ActivatedDate>2024-11-21T10:51:24.4845488+00:00</ActivatedDate>
      <Allowance>11</Allowance>
      <AllowanceUsed>10.1</AllowanceUsed>
      <CustomerName>sample string 5</CustomerName>
      <HasBoltons>true</HasBoltons>
      <ICCID>sample string 3</ICCID>
      <Id>baafae61-964b-4551-a385-6844f95235a6</Id>
      <MobileNumber>sample string 2</MobileNumber>
      <Operator>sample string 4</Operator>
      <SimTag>sample string 6</SimTag>
      <State>Active</State>
      <Tariff>sample string 8</Tariff>
      <TariffAllowance>9</TariffAllowance>
    </SimpleSimModel>
  </Sims>
  <Type>sample string 2</Type>
  <Usage>1</Usage>
</PoolModel>