API 1.0 – Set Inbox Document Status

This API is used to set a status for an Inbox document. A consignment id, which is required to fire this API, can be obtained by firing the Get Inbox Documents API. The status should be a valid status supported by the document. Supported statuses for an Inbox document can be obtained again from the Get Inbox Document API under the Possible Consignment Statuses field. Instead of Status, StatusCode can also be used to update status. Either Status or StatusCode should be present in the request. The request and response format for the “Set Inbox Document Status” API are given below:

API Code

SET_INBOX_DOC_STATUS

Request

<SOAP:Envelope  xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Header/>
    <SOAP:Body>
        <SetInboxDocumentStatus xmlns="http://ws.vg.pw.com/external/1.0">
            <ConsignmentId>
        CLEA0000000149223370677397471774EXCNL000002INCC9223370677387815337UA000000014000003
            </ConsignmentId>
<!-- ExternalId (XCNIN10020) can be used as a value for ConsignmentId --><br><!-- Only use Status or StatusCode and not both. They have to match orherwise you get a error. -->
            <!-- <Status>Approved</Status> -->
            <StatusCode>20</StatusCode>
        </SetInboxDocumentStatus>
    </SOAP:Body>
</SOAP:Envelope>

Note:  ConsignmentId is no longer in use. Instead, please use ExternalId.

Response

<SOAP:Envelope  xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Header/>
    <SOAP:Body>
        <SetInboxDocumentStatusResponse>
            <ConsignmentId>
        CLEA0000000149223370677397471774EXCNL000002INCC9223370677387815337UA000000014000003
            </ConsignmentId>
        </SetInboxDocumentStatusResponse>
    </SOAP:Body>
</SOAP:Envelope>

Note :  The usage of the ConsignmentId is no more recommended. Please use ExternalId instead. ConsignmentId is still retained in response for your reference.

Request Parameters

The following table detail the request parameter used:

Parameters Description
ConsignmentId This parameter gives the id of the inbox document on which the status has to be set. The value can be either ConsignmentId or ExternalId.
ConsignmentId is no longer in use. Instead, please use ExternalId.
Status This parameter gives the status that has to set on the document. This value has to be provided in the request if StatusCode is not provided.
Only use Status or StatusCode and not both. They have to match orherwise you get a error.
StatusCode This parameter gives the status code that has to set on the document. This value has to be provided in the request if Status is not provided.
For possible status values and code, see Configure Document Template Status. Take note of the possible values for Inbox Statuses.

 

Response Parameters

The following table detail the request parameter used:

Parameters Description
ConsignmentId This parameter gives the id of the inbox document for which the status was set.
The usage of the ConsignmentId is no more recommended. Please use ExternalId instead. ConsignmentId is still retained in response for your reference.