GetServicePlanList

Returns a list of all data service plans that are associated with a specified account.

Uses and Requirements

Several APIs require a service plan code to set or change a device's service plan, including ChangeDeviceState, ChangeDeviceServicePlan, Change4GDeviceIdentifier, and . You can use the values returned by GetServicePlanList with those APIs.

NOTE: The M2M_CPN plan is used by the M2M Platform and is not a valid plan code to use with any APIs.

Request Parameters

Parameter Type Description
Account
required
string The name of the account for which a list of service plans is requested. An account name is usually numeric, and must include any leading zeros.

Response Parameters

Parameter Type Description
ServicePlans list of ServicePlan The list of service plans associated with the account.
Name string The name of the service plan.
Code string The code of the service plan, which may not be the same as the Name.
SizeKB int The size of the service plan in kilobytes.
CarrierServicePlancode string The code that is used by the carrier for the service plan.
ExtendedAttributes ExtendedAttributesObj Any extended attributes for the service plan, as Key and Value pairs.
Key string The key for an extended attribute.
Value string The value of an extended attribute.

Example SOAP Request

<soapenv:Envelope 
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:v2="http://nphase.com/unifiedwebservice/v2" 
  xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.AccountService">
     <soapenv:Header>
       <v2:token>current_session_token</v2:token>
     </soapenv:Header>
     <soapenv:Body>
        <v2:GetServicePlanList>
           <v2:Input>
              <nph:Account>account_name</nph:Account>
           </v2:Input>
        </v2:GetServicePlanList>
     </soapenv:Body>
 </soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetServicePlanListResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.AccountService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:ServicePlans>
          <a:ServicePlan>
            <a:Name>T Plan 2</a:Name>
            <a:Code>T2</a:Code>
            <a:SizeKb>0</a:SizeKb>
            <a:CarrierServicePlanCode>74199</a:CarrierServicePlanCode>
            <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
          </a:ServicePlan>
          <a:ServicePlan>
            <a:Name>T Plan 1</a:Name>
            <a:Code>T1</a:Code>
            <a:SizeKb>0</a:SizeKb>
            <a:CarrierServicePlanCode>74198</a:CarrierServicePlanCode>
            <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
          </a:ServicePlan>
        </a:ServicePlans>
      </Output>
    </GetServicePlanListResponse>
  </s:Body>
</s:Envelope>

Request Schema Diagram

Response Schema Diagram