# Get Outbox Documents v3.1
This API is used to retrieve outbox documents for a specific entity, group or user. On firing the Get Outbox Documents API, the meta info for a batch of outbox documents belonging to the specified target will be fetched. This meta info will contain the ExternalId which can be used to fetch the complete details of a particular outbox document using the Get Outbox Document API. The request and response format for the “GetOutboxDocuments” API are given below:
# Header fields
Fieldname | Description |
---|---|
SOAPAction | Mandatory http://api.everbinding.nl/v3_1/GetOutboxDocuments |
# Request fields
Fieldname | Description |
---|---|
GroupId | GroupId that has access to the Inbox. (case sensitive) |
EConnectPartyId | An ID generated by the platform (XCccnnnnnn). (case sensitive) |
Paging | Defines the current result set |
Search | See: Document filters |
# Example request
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<S:Header>
<h:Authentication xmlns="http://api.everbinding.nl/v3_1/" xmlns:h="http://api.everbinding.nl/v3_1/">
<SecurityToken>o2S1qTusL29hp3IgMKWsn2I5CFV2LmZ2ZmR2AQp4AGN0BQZmATH3ZwHkAQH1LGL2AGx0VvkiLKI0nS9ho25wMG0vZwx0BQL0BQpkVvkiLKI0nS90nJ1yp3EuoKN9VwR1ZQD4Amx5ZmRvYT9uqKEbK3AcM25uqUIlMI9gMKEbo2D9VxuADHZgH0uOZFVfo2S1qTusqzIlp2yiow0vZF4jVvkiLKI0nS90o2gyow0vZzWnpKplLaD3M3qSqHuiA0ygJxcLAauJEwZ5GGV4oyZvYT9uqKEbK3AcM25uqUIlMG0vMx01oHIKFzAnZ1RmryAYnUIGAzW0IaqRAaIMWGARVt==</SecurityToken>
</h:Authentication>
</S:Header>
<S:Body xmlns="http://api.everbinding.nl/v3_1/">
<GetDocuments xmlns="http://api.everbinding.nl/v3_1/">
<GroupId>XCNL10019</GroupId>
<Paging>
<Limit>5</Limit>
<StartPage>75</StartPage>
</Paging>
<Search>
<CreatedOn>
<To>2017-01-10T00:00:00.000+01:00</To>
<From>2016-02-01T16:12:09.924+01:00</From>
</CreatedOn>
</Search>
</GetDocuments>
</S:Body>
</S:Envelope>
# Response fields
Fieldname | Description |
---|---|
Results | List of Documents |
Document | Metadata for found Document |
PagingResponse | Defines the next result set. |
# Response 200
<?xml version="1.0" encoding="utf-8"?>
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Body>
<GetDocumentsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://api.everbinding.nl/v3_1/">
<Results>
<Document>
<ExternalId>XDGR1473324052139</ExternalId>
<DocumentId>RA000000218DMP1000324</DocumentId>
<Subject>001827 TestInkoop Multi PDF(4) + Multi wrong type(2)</Subject>
<CreatedOn>2016-09-08T08:40:52.156Z</CreatedOn>
<ModifiedOn>2016-09-08T08:40:52.156Z</ModifiedOn>
<Sender/>
<Receiver/>
<Status>
<Name>Klaar voor verwerking</Name>
<Code>20</Code>
</Status>
<Template>
<Id>GLDT9223370606989915978RA000000006DTP2000109</Id>
<Name>Conversietaak</Name>
<MasterId>GLDT9223370606989915978RA000000006DTP2000109</MasterId>
<MasterName>Conversietaak</MasterName>
</Template>
<Transaction>
<DeliveryMethod>None</DeliveryMethod>
</Transaction>
</Document>
<Document>
<ExternalId>XDGR1473324050772</ExternalId>
<DocumentId>RA000000218DMP1000323</DocumentId>
<Subject>001826 TestInkoop Multi PDF(4) + Multi wrong type(2)</Subject>
<CreatedOn>2016-09-08T08:40:50.791Z</CreatedOn>
<ModifiedOn>2016-09-08T08:40:50.791Z</ModifiedOn>
<Sender/>
<Receiver/>
<Status>
<Name>Klaar voor verwerking</Name>
<Code>20</Code>
</Status>
<Template>
<Id>GLDT9223370606989915978RA000000006DTP2000109</Id>
<Name>Conversietaak</Name>
<MasterId>GLDT9223370606989915978RA000000006DTP2000109</MasterId>
<MasterName>Conversietaak</MasterName>
</Template>
<Transaction>
<DeliveryMethod>None</DeliveryMethod>
</Transaction>
</Document>
</Results>
<PagingResponse>
<NextPage>80</NextPage>
</PagingResponse>
</GetDocumentsResponse>
</SOAP:Body>
</SOAP:Envelope>