GetOutboxDocument

This API is used to retrieve a single outbox document. A ExternalId, which is required to fire this API, can be obtained by firing the “GetOutboxDocuments” API. On receiving the ExternalId, the “Get Outbox Document” API can be fired to fetch the complete information about that particular document. The request and response format for the “Get Outbox Document” API are given below.

Header fields
Fieldname Description
SOAPAction [Mandatory] http://api.everbinding.nl/v3_1/GetOutboxDocument
Request fields
Fieldname Description
ExternalId Id from document to be fetched. This Id can be retrieved with GetOutputDocuments
Response fields
Fieldname Description
Details Details of the document including the document as payload. This is the UBL file without the XML Prolog
Statuses List of possible statuses for the used template. This list should be used for changing the status of the documents.

Request body

<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <GetOutboxDocument xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.everbinding.nl/v3_1/">
      <ExternalId>ExternalId1</ExternalId>
    </GetOutboxDocument>
  </Body>
</Envelope>

Response 200

<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <GetOutboxDocumentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.everbinding.nl/v3/">
      <Details>
        <ExternalId>ExternalId1</ExternalId>
        <DocumentId>DocumentId1</DocumentId>
        <Subject>Subject1</Subject>
        <CreatedOn>1900-01-01T01:01:01.0000000+00:00</CreatedOn>
        <ModifiedOn>1900-01-01T01:01:01.0000000+00:00</ModifiedOn>
        <Sender>
          <EConnectPartyId>EConnectPartyId1</EConnectPartyId>
          <Name>Name1</Name>
        </Sender>
        <Reciever>
          <EConnectPartyId>EConnectPartyId1</EConnectPartyId>
          <Name>Name1</Name>
        </Reciever>
        <Status>
          <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>
        </Status>
        <Template>
          <Id>Id1</Id>
          <Name>Name1</Name>
          <MasterId>MasterId1</MasterId>
          <MasterName>MasterName1</MasterName>
        </Template>
        <Transaction>
          <Endpoint>Endpoint1</Endpoint>
          <MessageId>MessageId1</MessageId>
          <SenderReferenceId>SenderReferenceId1</SenderReferenceId>
          <ReceiverReferenceId>ReceiverReferenceId1</ReceiverReferenceId>
        </Transaction>
        <Payload>
          <any_element>anyType</any_element>
        </Payload>
      </Details>
      <Statuses>
        <Status>
          <Name>Name1</Name>
          <Code>Code1</Code>
        </Status>
        <Status xsi:nil="true" />
        <Status>
          <Name>Name2</Name>
          <Code>Code2</Code>
        </Status>
        <Status xsi:nil="true" />
        <Status>
          <Name>Name3</Name>
          <Code>Code3</Code>
        </Status>
      </Statuses>
    </GetOutboxDocumentResponse>
  </Body>
</Envelope>

 

Was this article helpful?

Yes No