GET api/External?status={status}&tenantId={tenantId}&changedAfter={changedAfter}

Returns a list of documents that need to be processed. Digipoort only sees Digipoort items, but it is possible for items to disapear from this list when the client cancells or force approves the document. filters: status: Only give back documents with this state. tenantId : Only give back documents for tenant identified by this Tenantid. changedAfter: Only give back documents changed after this time.Leaving a filter will give back everything unresticted of the filter.When leaving the filter tenantId all information of all tenants will be returned which are linked to the requesting provider.The requesting Provider is determined by certificate validation.Authorisation(s) : Portal application with an active usage entry in the tenant.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
status

Requested State for the document list

ProcessingStatus

None.

tenantId

Requested tenantId of tenant for the document list

string

None.

changedAfter

Requested changed after date/time for the document list

date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PollingListItem
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Status

ProcessingStatus

None.

Tenant

string

None.

CommandState

Can contain null, Cancel, ForceApproval

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "e373fa52-38e4-4116-9cdf-09bdf45b7d38",
    "Status": "Pending",
    "Tenant": "sample string 2",
    "CommandState": "sample string 3"
  },
  {
    "Id": "e373fa52-38e4-4116-9cdf-09bdf45b7d38",
    "Status": "Pending",
    "Tenant": "sample string 2",
    "CommandState": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPollingListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MessageExpresse.Models">
  <PollingListItem>
    <CommandState>sample string 3</CommandState>
    <Id>e373fa52-38e4-4116-9cdf-09bdf45b7d38</Id>
    <Status>Pending</Status>
    <Tenant>sample string 2</Tenant>
  </PollingListItem>
  <PollingListItem>
    <CommandState>sample string 3</CommandState>
    <Id>e373fa52-38e4-4116-9cdf-09bdf45b7d38</Id>
    <Status>Pending</Status>
    <Tenant>sample string 2</Tenant>
  </PollingListItem>
</ArrayOfPollingListItem>