CheckOrderStatus

Checks the status of an activation order and lists where the order is in the provisioning process. The information is returned in a callback response, so you must register a URL endpoint to receive DeviceService callback messages using the Register Callback API in the Callback Registration Service.

Uses and Requirements

You can use this request to track the status of an activation order and monitor the progress.

Request Parameters

Parameter	Type	Description
AccountName required	string	The name of the account that you want the callback response sent to. Account names are usually numeric and must include any leading zeros.
OrderRequestId optional if DeviceList is provided	string	The request id from the activation order.
DeviceList optional if OrderRequestID is provided	DeviceCollection	At this time, only one device in DeviceCollection is allowed per request. <DeviceCollection> <DeviceIndentifiers> <DeviceIdentifier> <Kind>identifier_type</Kind> <Identifier>identifier_value</Identifier> </DeviceIdentifier> </DeviceIndentifiers> </DeviceCollection>
Kind required for DeviceList	string	The type of the device identifier. Valid types of identifiers are: ESN (decimal) ICCID (up to 20 digits) MEID (hexadecimal)
Identifier required for DeviceList	string	The value of the device identifier.

Response Parameters

Parameter	Type	Description
RequestId	string	A unique string that associates the request with the results that are sent via a callback service. The callback message will contain the information for all devices in the request.

Callback Response Parameters

Parameter	Type	Description
CallbackRequest	CallbackRequest	Wrapper element for all callback elements.
Username	string	The username defined when a URL was registered for the callback service, or an empty element if no username was defined.
Password	string	The password defined when a registered for the callback service, or an empty element if no password was defined.
RequestId	string	A unique string that matches the RequestId returned in the synchronous response to the original API request. A separate callback message is sent for each device that matched the request criteria, indicating whether the operation succeeded for that device. All of the callback messages will have the same RequestId.
Data	CallbackData	The data elements for this callback.
CarrierService	CarrierServiceCallbackRequest	Null for this callback service.
ExternalProvisioningChange	ExternalProvisioningChange	Null for this callback service.
PromoChange	PromoChange	Null for this callback service.
SMSDelivery	SMSDelivery	Null for this callback service.
PRLInformation	PRLInformation	Null for this callback service.
DeviceService	DeviceServiceCallbackRequest	The data returned from a DeviceService API request.
CheckOrderStatus	CheckOrderStatus	The list of steps/stages (pinpoints) in the provisioning process.
OrderTrackingRequestId	string	The request ID of the activation order.
Action	string	The provisioning request that was made. At this time, only Activations are supported.
StartDate	dateTime	The date and time the provisioning request was made.
EndDate	dateTime	The date and time when the callback was sent.
Stages	Stages	A list of all pinpoints identifying the steps/stages in the provisioning process.
Stage	Stage	A specific step/stage in the provisioning process.
Name	string	The name identifying the provisioning step/stage.
Date	dateTime	The date and time the request entered this step/stage of the provisioning process.
Status	string	The status of whether the request completed this step/stage of the provisioning process. Status can be Success or Failure.
Notes	string	If the step/stage failed, then the error message will be provided here.
GoToState	GoToState	Null for this callback service.
DeviceProfileService	DeviceProfileService	Null for this callback service.
AlertService	AlertService	Null for this callback service.
InternalService	InternalService	Null for this callback service.
DiagnosticsService	DiagnosticsService	Null for this callback service.
Fault	Fault	Null for this callback service.
Comment	string	Null for this callback service.
Summary	SummaryReport	Null for this callback service.
Status	string	The status for the API request.
CallbackCount	integer	The number of times this callback message has been sent.
MaxCallbackThreshold	integer	The maximum number of times this callback message will be sent if it is not correctly acknowledged.

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.DeviceService"
 xmlns:nph1="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common">
  <soapenv:Header>
    <token xmlns="http://nphase.com/unifiedwebservice/v2">48178f0c-4407-4db5-bae7-ec13e5968ffd</token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:CheckOrderStatus>
      <v2:Input>
        <nph:AccountName>0251687987-0001</nph:AccountName>
        <nph:OrderRequestId>ae1b5618-7620-4197-ab54-bb1d13c561234</nph:OrderRequestId>
        <nph:DeviceList>
          <nph1:DeviceIdentifierCollection>
            <nph1:DeviceIdentifiers>
              <nph1:DeviceIdentifier>
                <nph1:Kind>iccid</nph1:Kind>
                <nph1:Identifier>89148000000040400149</nph1:Identifier>
              </nph1:DeviceIdentifier>
            </nph1:DeviceIdentifiers>
          </nph1:DeviceIdentifierCollection>
        </nph:DeviceList>
      </v2:Input>
    </v2:CheckOrderStatus>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <CheckOrderStatus 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.DeviceService">
        <a:RequestId>0aeb5618-7620-4197-ab54-bb1d13c56dc9</a:RequestId>
      </Output>
    </CheckOrderStatus>
  </s:Body>
</s:Envelope>

Example SOAP Callback Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <CallbackRequest xmlns="http://nphase.com/unifiedwebservice/v2">
      <Username/>
      <Password/>
      <RequestId>0aeb5618-7620-4197-ab54-bb1d13c56dc9</RequestId>
      <Device>
        <Kind>ICCID</Kind>
        <Identifier>89148000000040400149</Identifier>
      </Device>
      <Data>
          <CarrierService xsi:nil="true"/>
          <ExternalProvisioningChange xsi:nil="true"/>
          <PromoChange xsi:nil="true"/>
          <SMSDelivery xsi:nil="true"/>
          <PRLInformation xsi:nil="true"/>
          <DeviceService>
            <CheckOrderStatus>
              <OrderTrackingRequestId>ae1b5618-7620-4197-ab54-bb1d13c561234</OrderTrackingRequestId>
              <Action>Activation</Action>
              <Status>In Progress</Status>
              <StartDate>2019-05-20T11:21:32.404-04:00</StartDate>
              <EndDate></EndDate>
              <Stages>
                <Stage>
                  <Name>Request Received</Name>
                  <Date>2019-05-20T11:21:32.404-04:00</Date>
                  <Status>Success</Status>
                  <Notes></Notes>
                </Stage>
                <Stage>
                  <Name>Account and credit verification</Name>
                  <Date>2019-05-20T11:21:34.404-04:00</Date>
                  <Status>Success</Status>
                  <Notes></Notes>
                </Stage>
                <Stage>
                  <Name>Device verification</Name>
                  <Date>2019-05-20T11:21:36.404-04:00</Date>
                  <Status>Success</Status>
                  <Notes></Notes>
                </Stage>
                <Stage>
                  <Name>Number and IP allocation</Name>
                  <Date>2019-05-20T11:21:38.404-04:00</Date>
                  <Status>Success</Status>
                  <Notes></Notes>
                </Stage>
                <Stage>
                  <Name>Provisioning configuration</Name>
                  <Date>2019-05-20T11:21:40.404-04:00</Date>
                  <Status>Success</Status>
                  <Notes></Notes>
                </Stage>
                <Stage>
                  <Name>Network registration</Name>
                  <Date>2019-05-20T11:21:42.404-04:00</Date>
                  <Status>Success</Status>
                  <Notes></Notes>
                </Stage>
                <Stage>
                  <Name>Order completion</Name>
                  <Date>2019-05-20T11:21:44.404-04:00</Date>
                  <Status>Success</Status>
                  <Notes></Notes>
                </Stage>
                <Stage>
                  <Name>Callback Sent</Name>
                  <Date>2019-05-20T11:21:45.404-04:00</Date>
                  <Status>Success</Status>
                  <Notes></Notes>
                </Stage>
              </Stages>
            </CheckOrderStatus>
          </DeviceService>
          <GoToState xsi:nil="true"/>
          <DeviceProfileService xsi:nil="true"/>
          <AlertService xsi:nil="true"/>
          <InternalService xsi:nil="true"/>
          <DiagnosticsService xsi:nil="true"/>
          <Fault xsi:nil="true"/>
          <Comment xsi:nil="true"/>
          <Summary xsi:nil="true"/>
          <Status>Success</Status>
          <CallbackCount>1</CallbackCount>
          <MaxCallbackThreshold>4</MaxCallbackThreshold/>
        </Data>
      </Data>
    </CallbackRequest>
  </s:Body>
</s:Envelope>