Query a Device

Queries the subscriber database for a device based on External ID, Device ID, Imsi, or Access Number.

Aggregation queries query the Activity database. The cycle alignment API queries a catalog item (purchased offer, bundle, or balance) for cycles that can be aligned to on purchase or modification. Only cycles that are not currently aligned are returned. You must provide an OfferRequest payload or an OfferResourceId.

REST Example 1

URL 
GET http://host:port/rsgateway/data/v3/device/<Device OID>
Request XML None
Response 
<MtxResponseDevice>
    <ObjectId>0-2-5-1</ObjectId>
    <ExternalId>1234567890</ExternalId>
    <Status>1</Status>
    <StatusDescription>Active</StatusDescription>
    <DeviceType>0</DeviceType>
    <Attr>
        <TrainingDeviceObjectExtension>
            <TAC_Code>PM123</TAC_Code>
            <Imsi>1234567890</Imsi>
            <AccessNumberArray>
                <value>1234567890</value>
            </AccessNumberArray>
        </TrainingDeviceObjectExtension>
    </Attr>
    <RouteId>1</RouteId>
    <Result>0</Result>
    <ResultText>OK</ResultText>
</MtxResponseDevice>

Rest Example 2

URL GET http://host:port/rsgateway/data/v3/device/<Device OID>/aggregation
Request XML None
Response 
<MtxResponseAggregationInfo>
  <AggregationList>
    <MtxEvent>
      <UsageQuantityList>
        <MtxEventUsageQuantity>
          <QuantityType>4</QuantityType>
          <QuantityUnit>200</QuantityUnit>
          <Flags>1</Flags>
          <MsgAmount>215040.0000</MsgAmount>
          <RatingAmount>215040.0000</RatingAmount>
        </MtxEventUsageQuantity>
      </UsageQuantityList>
      <UsageUtcOffset>0</UsageUtcOffset>
      <LastUsageRoundingAmount>0.0000</LastUsageRoundingAmount>
      <UsageRoundingAmount>0.0000</UsageRoundingAmount>
      <UsageRoundingAmountUnit>200</UsageRoundingAmountUnit>
      <EventTypeArray>
        <value>1</value>
        <value>1</value>
        <value>3</value>
      </EventTypeArray>
      <AppliedOfferArray>
        <MtxEventAppliedOffer>
          <UsageQuantity>215040.0000</UsageQuantity>
          <UsageQuantityUnit>200</UsageQuantityUnit>
          <ProductOfferId>20</ProductOfferId>
          <ProductOfferExternalId>Offer1</ProductOfferExternalId>
          <ProductOfferOwnerId>0-1-5-135</ProductOfferOwnerId>
          <ProductOfferResourceId>2</ProductOfferResourceId>
          <ProductOfferVersion>0</ProductOfferVersion>
          <PurchasedOfferAttr>
            <CustomPurchaseOfferExtension />
          </PurchasedOfferAttr>
        </MtxEventAppliedOffer>
      </AppliedOfferArray>
      <AggregationId>0-1-19-270</AggregationId>
      <InitiatorId>0-1-5-135</InitiatorId>
      <InitiatorExternalId>106</InitiatorExternalId>
      <InitiatorDeviceId>0-1-5-137</InitiatorDeviceId>
      <Flags>0</Flags>
      <WalletId>0-1-5-136</WalletId>
      <WalletOwnerId>0-1-5-135</WalletOwnerId>
      <WalletOwnerExternalId>106</WalletOwnerExternalId>
      <BalanceUpdateArray>
        <MtxBalanceUpdate>
          <BalanceClassId>20003</BalanceClassId>
          <BalanceTemplateId>21018</BalanceTemplateId>
          <BalanceIntervalId>1</BalanceIntervalId>
          <BalanceResourceId>1</BalanceResourceId>
          <BalanceStartTime>2014-03-31T00:00:00.000000+13:00</BalanceStartTime>
          <BalanceEndTime>2014-04-30T00:00:00.000000+12:00</BalanceEndTime>
          <Flags>0</Flags>
          <Amount>0.20508</Amount>
        </MtxBalanceUpdate>
      </BalanceUpdateArray>
      <ChargeList>
        <MtxEventCharge>
          <UsageQuantity>215040.0000</UsageQuantity>
          <UsageQuantityUnit>200</UsageQuantityUnit>
          <AppliedOfferIndex>0</AppliedOfferIndex>
          <BalanceUpdateIndex>0</BalanceUpdateIndex>
          <UpdateType>1</UpdateType>
          <Amount>0.205078125</Amount>
        </MtxEventCharge>
      </ChargeList>
      <EventTime>2014-04-05T13:09:00.000000Z</EventTime>
      <Duration>60000000</Duration>
      <EventId>0:1:19:270_0</EventId>
    </MtxEvent>
  </AggregationList>
  <RouteId>1</RouteId>
  <Result>0</Result>
  <ResultText>OK</ResultText>
</MtxResponseAggregationInfo>