GetInboxDocuments

This API is used to retrieve inbox documents for a specific entity, group or user. On firing the “Get Inbox Documents” API, the meta info for a batch of inbox 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 inbox document using the “Get Inbox Document” API. The request and response format for the “Get Inbox Documents” API are given below:

DocumentList of Documents

Header fields
Fieldname Description
SOAPAction [Mandatory] http://api.everbinding.nl/v3_1/GetInboxDocuments
Request fields
Fieldname Description
GroupId GroupId that has access to the Inbox. (case sensitive)
EConnectPartyId A ID generated by the platform. (XCccnnnnnn). (case sensitive)
If both EConnectPartyId and GroupId are absent, the inbox documents for the user who fired the request will be fetched.
If both EConnectPartyId and GroupId are used, the inbox documents for GroupId will be fetched.
Paging Defines the current result set. See: Paging (Default is a limit of 10. So it is required)
Search See: Document Search also for synchronisation
Response fields
Fieldname Description
Results List of Documents
Document Metadata for found Document
PagingResponse Defines the next result set. See: Paging

Example1

Request body

<?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>o2S1qTusL29hp3IgMKWsn2I5CFV2LmZ2ZmR2AQp4AGN0BQZmATH3ZwHkAQH1LGL2AGx0VvkiLKI0nS9ho25wMG0vZGtjZQx2BQNjZPVfo2S1qTusqTygMKA0LJ1jCFVkAGN0BQplBQVmVvkiLKI0nS9mnJqhLKE1pzIsoJI0nT9xCFWVGHSQYIAVDGRvYT9uqKEbK3MypaAco249VwRhZPVfo2S1qTusqT9eMJ49VwAnnyIRD0MdAmZ0p3ywpIyYoKqJpTk6qyMVFRqVMyWMVvkiLKI0nS9mnJqhLKE1pzH9VyIPLzgDnayEoHELBJAHESIgI01AHHyGWGWTL0IAWGARVt==</SecurityToken></h:Authentication></S:Header>
<S:Body xmlns="http://api.everbinding.nl/v3_1/">
    <GetInboxDocuments xmlns="http://api.everbinding.nl/v3_1/">
        <GroupId>XCNL10019</GroupId>
        <EConnectPartyId></EConnectPartyId>
        <Paging>
            <Limit>30</Limit>
            <StartPage>90</StartPage>
        </Paging>
        <Search>
            <CreatedOn>
                <To>2017-01-10T00:00:00.000+01:00</To>
                <From>2016-02-01T14:13:42.383+01:00</From>
            </CreatedOn>
        </Search>
    </GetInboxDocuments>
</S:Body></S:Envelope>

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><Document><ExternalId>XDGR1473324048950</ExternalId><DocumentId>RA000000218DMP1000322</DocumentId><Subject>001825 TestInkoop Multi PDF(4) + Multi wrong type(2)</Subject><CreatedOn>2016-09-08T08:40:48.987Z</CreatedOn><ModifiedOn>2016-09-08T08:40:48.987Z</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>XDGR1473324047257</ExternalId><DocumentId>RA000000218DMP1000321</DocumentId><Subject>001824 TestInkoop Multi PDF(4) + Multi wrong type(2)</Subject><CreatedOn>2016-09-08T08:40:47.276Z</CreatedOn><ModifiedOn>2016-09-08T08:40:47.276Z</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>XDGR1473323918310</ExternalId><DocumentId>RA000000218DMP1000320</DocumentId><Subject>001823 TestInkoop MULT PDF</Subject><CreatedOn>2016-09-08T08:38:38.326Z</CreatedOn><ModifiedOn>2016-09-08T08:38:38.326Z</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>

 

Was this article helpful?