This API is used to get the current status from an Inbox document. A ExternalId, which is required to fire this API, can be obtained by firing the GetOutboxDocuments API. Difference between the results of this call and the result of GetOutboxDocument is the additional information about who en when the status is changed. The <Info> part.
The request and response format for the “GetOutboxDocumentStatus” API are given below.
| Header fields | |
|---|---|
| Fieldname | Description |
| SOAPAction | [Mandatory] http://api.everbinding.nl/v3_1/GetOutboxDocumentStatus |
| Request fields | |
| Fieldname | Description |
| ExternalId | The ID of the document whose status should be changed. This Id can be retrieved with GetOutputDocuments |
| Response fields | |
| Fieldname | Description |
| Details/Name | Display value of status |
| Details/Code | Value of the status of the document |
| Details/Info | Information about the status change |
Request body
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<GetOutboxDocumentStatus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.everbinding.nl/v3_1/">
<ExternalId>ExternalId1</ExternalId>
</GetOutboxDocumentStatus>
</Body>
</Envelope>
Response 200
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<GetOutboxDocumentStatusResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.everbinding.nl/v3_1/">
<Details>
<Name>Name1</Name>
<Code>Code1</Code>
<Info>
<UserId>UserId1</UserId>
<UserName>UserName1</UserName>
<AccountId>AccountId1</AccountId>
<AccountName>AccountName1</AccountName>
<ChangedOn>1900-01-01T01:01:01.0000000+00:00</ChangedOn>
</Info>
</Details>
</GetOutboxDocumentStatusResponse>
</Body>
</Envelope>