Transfer Status Query

Last updated
Save as PDF

The Transfer Status Query allows clients to inquire the status of their unit transfer requests. It is possible to request the status of all transactions in one batch (ActionCollection) or single transactions (Actions) individually.

Until a transaction has been completed (either success or error), the query will return a status of 'pending'.

Object Identifier

The status query operation is identified by the following OID in the procedure element:

urn:oid:1.3.6.1.4.1.1449.60.9.2.30.1

Input Parameters

Query requests contain the same attributes as introduced in the Generic Action Model section. The client is required to provide unique transaction ids for ActionCollection and Actions.

Instead of a unit serial number, the status query contains the transaction id of the inquired ActionCollection in the Entity element. With this, the OID of the Entity changes to:

urn:oid:1.3.6.1.4.1.1449.5.1

If one individual transaction is queried, the Action transaction id needs to be provided in the Procedure element. An Action transaction id is not provided if the entire ActionCollection is queried.

Sample Request (ActionCollection)

<actionCollection xmlns="urn:oid:1.3.6.1.4.1.1449.5.1" version="1.0" source="QUALCOMM" co_id="1" trans_id="2">
    <action trans_id="1">
        <actionTime>
            <beginTime>2008-10-15T09:47:56.803-07:00</beginTime>
        </actionTime>
        <entity>
            <oid>urn:oid:1.3.6.1.4.1.1449.5.1</oid>
            <valueBinary name="collection_trans_id">1</valueBinary>
        </entity>
        <procedure>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.2.30.1</oid>
        </procedure>
    </action>
</actionCollection>

Sample Response (ActionCollection)

<actionCollection xmlns="urn:oid:1.3.6.1.4.1.1449.5.1" version="1.0" source="QUALCOMM" co_id="1" trans_id="1">
    <action trans_id="1">
        <actionTime>
            <beginTime>2010-09-15T12:08:47.28125-08:00</beginTime>
            <endTime>2010-09-15T12:08:52.28125-08:00</endTime>
        </actionTime>
        <entity>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.1.3000.1</oid>
            <valueBinary name="SERIAL_NO">123456789</valueBinary>
        </entity>
        <procedure>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.2.3000.1</oid>
            <valueBinary name="NMC_ACCOUNT">12345</valueBinary>
            <valueBinary name="COMMENT">TRANSFER REQUESTED BY JSMITH</valueBinary>
            <valueBinary name="RESULT_STATUS">SUCCESS</valueBinary>
            <valueBinary name="RESULT_CODE">0</valueBinary>
            <valueBinary name="RESULT_DESC"/>
        </procedure>
    </action>
    <action trans_id="2">
        <actionTime>
            <beginTime>2010-09-15T12:08:47.28125-08:00</beginTime>
            <endTime>2010-09-15T12:08:56.28125-08:00</endTime>
        </actionTime>
        <entity>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.1.3000.1</oid>
            <valueBinary name="SERIAL_NO">123456790</valueBinary>
        </entity>
        <procedure>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.2.3000.1</oid>
            <valueBinary name="NMC_ACCOUNT">12345</valueBinary>
            <valueBinary name="COMMENT">TRANSFER REQUESTED BY JSMITH</valueBinary>
            <valueBinary name="RESULT_STATUS">SUCCESS</valueBinary>
            <valueBinary name="RESULT_CODE">0</valueBinary>
            <valueBinary name="RESULT_DESC"/>
        </procedure>
    </action>
    <action trans_id="3">
        <actionTime>
            <beginTime>2010-09-15T12:08:47.28125-08:00</beginTime>
            <endTime>2010-09-15T12:09:04.28125-08:00</endTime>
        </actionTime>
        <entity>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.1.3000.1</oid>
            <valueBinary name="SERIAL_NO">123456791</valueBinary>
        </entity>
        <procedure>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.2.3000.1</oid>
            <valueBinary name="NMC_ACCOUNT">12345</valueBinary>
            <valueBinary name="COMMENT">TRANSFER REQUESTED BY JSMITH</valueBinary>
            <valueBinary name="RESULT_STATUS">ERROR</valueBinary>
            <valueBinary name="RESULT_CODE">40100</valueBinary>
            <valueBinary name="RESULT_DESC">The provided serial number is invalid.</valueBinary>
        </procedure>
    </action>
</actionCollection>

Sample Request (Action)

<actionCollection xmlns="urn:oid:1.3.6.1.4.1.1449.5.1" version="1.0" source="QUALCOMM" co_id="1" trans_id="2">
    <action trans_id="1">
        <actionTime>
            <beginTime>2008-10-15T09:47:56.803-07:00</beginTime>
        </actionTime>
        <entity>
            <oid>urn:oid:1.3.6.1.4.1.1449.5.1</oid>
            <valueBinary name="collection_trans_id">1</valueBinary>
        </entity>
        <procedure>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.2.30.1</oid>
            <valueBinary name="action_trans_id">3</valueBinary>
        </procedure>
    </action>
</actionCollection>

Sample Response (Action)

 <actionCollection xmlns="urn:oid:1.3.6.1.4.1.1449.5.1" version="1.0" source="QUALCOMM" co_id="1" trans_id="1">
    <action trans_id="3">
        <actionTime>
            <beginTime>2010-09-15T12:08:47.28125-08:00</beginTime>
            <endTime>2010-09-15T12:09:04.28125-08:00</endTime>
        </actionTime>
        <entity>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.1.3000.1</oid>
            <valueBinary name="SERIAL_NO">123456791</valueBinary>
        </entity>
        <procedure>
            <oid>urn:oid:1.3.6.1.4.1.1449.60.9.2.3000.1</oid>
            <valueBinary name="NMC_ACCOUNT">12345</valueBinary>
            <valueBinary name="COMMENT">TRANSFER REQUESTED BY JSMITH</valueBinary>
            <valueBinary name="RESULT_STATUS">ERROR</valueBinary>
            <valueBinary name="RESULT_CODE">40100</valueBinary>
            <valueBinary name="RESULT_DESC">The provided serial number is invalid.</valueBinary>
        </procedure>
    </action>
</actionCollection>