GetRequestStatus

Returns the current status of an asynchronous request that was made for a single device.

Uses and Requirements

You can request the status of asynchronous requests that were run for a single device. You cannot check the status of requests that operated on multiple devices.

Request Parameters

The request must include the account name and the request ID for which you want status.

Parameter Type Description
AccountName
required
string The name of the account that sent the asynchronous request.
RequestId
required
string The asynchronous transaction request ID, found in the synchronous response to the original request.

Response Parameters

The response includes the request ID and the current status of the request.

Parameter Type Description
RequestIdStatus RequestStatus
RequestId string The unique ID of the asynchronous request.
Status string

The current status of the request:

  • Pending - The request is still being processed.
  • Success - The request has completed processing with no errors.
  • Failed - There were errors that prevented the request from being completed.

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.CarrierService">
  <soapenv:Header>
    <v2:token">75519e03-36fc-421d-84a7-23fff01c9e96</v2:token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:GetRequestStatus>
      <v2:Input>
        <nph:AccountName>0001234654-00001</nph:AccountName>
        <nph:RequestId>91bd36d3-a063-4600-928b-bb57eeccb9ad</nph:RequestId>
      </v2:Input>
    </v2:GetRequestStatus>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<GetRequestStatusResponse xmlns="http://nphase.com/unifiedwebservice/v2">
  <Output xmlns:a="http://schemas.datacontract.org/2004/07NPhase.UnifiedWebService.APIs.v2.Contract.CarrierService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <a:RequestIdStatus>
      <a:RequestId>91bd36d3-a063-4600-928b-bb57eeccb9ad</a:RequestId>
      <a:Status>Success</a:Status>
    </a:RequestIdStatus>  
  </Output>
</GetRequestStatusResponse>

Request Schema Diagram

Response Schema Diagram