GetStateAndServicesList

Returns a list of all customer-defined stage states and services defined for the account.

NOTE: This API is currently in limited release, and is not yet available to all customer accounts.

Request Parameters

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

Response Parameters

Parameter Type Description
Engagement EngagementInfo The list of engagements associated with the account.
Id string The engagement ID.
ChargingGroup string The Charging Group name.
Services ServiceInfo The list of services associated with the account.
Name string The name of the service.
Description string The description of the service.
States StateInfo The list of zero or more states in the service.
Name string The name of the state.
WorkflowSequenceNumber int The workflow sequence number of this state.
RatingGroup RatingGroupInfo The list of zero or more rating groups in the service.
Code string The rating group code.
RatingGroupMinValue string
RatingGroupMaxValue string
ServicePlan string The service plan used to charge for services for devices in this state.
ExtendedAttributes ExtendedAttributesObj Any extended attributes for the state, as Key and Value pairs
ExtendedAttributes ExtendedAttributesObj Any extended attributes for the service, as Key and Value pairs

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.StateService">
   <soapenv:Header/>
   <soapenv:Body>
      <v2:GetStateAndServicesList>
         <v2:Input>
            <nph:Account>010123456-00001</nph:Account>
         </v2:Input>
      </v2:GetStateAndServicesList>
   </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetStateAndServicesListResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
 xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.StateService">
        <a:Engagement>
          <a:EngagementInfo>
            <a:Id>3000</a:Id>
            <a:ChargingGroup>0000000000030010</a:ChargingGroup>
            <a:Services>
              <a:ServiceInfo>
                <a:Name>SGM</a:Name>
                <a:Description i:nil="true"/>
                <a:States>
                  <a:StateInfo>
                    <a:Name>WAM Enable - Provisioning</a:Name>
                    <a:WorkflowSequenceNumber>1</a:WorkflowSequenceNumber>
                    <a:RatingGroup/>
                    <a:ServicePlan xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <b:string>basic</b:string>
                    </a:ServicePlan>
                    <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
                  </a:StateInfo>
                  <a:StateInfo>
                    <a:Name>WAM Disable - Full Disconnect</a:Name>
                    <a:WorkflowSequenceNumber>2</a:WorkflowSequenceNumber>
                    <a:RatingGroup/>
                    <a:ServicePlan xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <b:string>Disabled</b:string>
                    </a:ServicePlan>
                    <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
                  </a:StateInfo>
                </a:States>
                <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
              </a:ServiceInfo>
              <a:ServiceInfo>
                <a:Name>SG1</a:Name>
                <a:Description i:nil="true"/>
                <a:States>
                  <a:StateInfo>
                    <a:Name>Wifi Router</a:Name>
                    <a:WorkflowSequenceNumber>1</a:WorkflowSequenceNumber>
                    <a:RatingGroup>
                       <a:RatingGroupInfo>
                       <a:Code>1800063118</a:Code>
                       <a:RatingGroupMinValue>10007</a:RatingGroupMinValue>
                       <a:RatingGroupMaxValue>10007</a:RatingGroupMaxValue>
                     </a:RatingGroupInfo>
                    </a:RatingGroup>
                    <a:ServicePlan xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <b:string>wifi_router</b:string>
                    </a:ServicePlan>
                    <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
                  </a:StateInfo>
                  <a:StateInfo>
                    <a:Name>WiFi Router2</a:Name>
                    <a:WorkflowSequenceNumber>2</a:WorkflowSequenceNumber>
                    <a:RatingGroup>
                       <a:RatingGroupInfo>
                       <a:Code>1800063118</a:Code>
                       <a:RatingGroupMinValue>10007</a:RatingGroupMinValue>
                       <a:RatingGroupMaxValue>10007</a:RatingGroupMaxValue>
                     </a:RatingGroupInfo>
                    </a:RatingGroup>
                    <a:ServicePlan xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <b:string>wifi_router</b:string>
                    </a:ServicePlan>
                    <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
                  </a:StateInfo>
                </a:States>
                <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
              </a:ServiceInfo>
            </a:Services>
          </a:EngagementInfo>
        </a:Engagement>
      </Output>
    </GetStateAndServicesListResponse>
  </s:Body>
</s:Envelope>

Request Schema Diagram

Response Schema Diagram