ECGridOS API v4
Click here for a complete list of operations.
InterchangeOutBoxArchiveEx
OutBox Interchange List for a specified Network/Mailbox.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /v4.1/prod/ecgridos.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://os.ecgrid.io/InterchangeOutBoxArchiveEx"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<InterchangeOutBoxArchiveEx xmlns="https://os.ecgrid.io/">
<SessionID>string</SessionID>
<NetworkID>int</NetworkID>
<MailboxID>int</MailboxID>
<BeginDate>dateTime</BeginDate>
<EndDate>dateTime</EndDate>
<ECGridIDFrom>int</ECGridIDFrom>
<ECGridIDTo>int</ECGridIDTo>
<InterchangeControlID>string</InterchangeControlID>
<PageNo>short</PageNo>
<RecordsPerPage>short</RecordsPerPage>
</InterchangeOutBoxArchiveEx>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<InterchangeOutBoxArchiveExResponse xmlns="https://os.ecgrid.io/">
<InterchangeOutBoxArchiveExResult>
<PageSize>short</PageSize>
<PageNumber>short</PageNumber>
<Count>int</Count>
<TotalRecords>int</TotalRecords>
<TotalPages>short</TotalPages>
<InterchangeIDInfoList>
<InterchangeIDInfo>
<InterchangeID>long</InterchangeID>
<InterchangeProcessDate>dateTime</InterchangeProcessDate>
<NetworkIDFrom>int</NetworkIDFrom>
<NetworkNameFrom>string</NetworkNameFrom>
<MailboxIDFrom>int</MailboxIDFrom>
<NetworkIDTo>int</NetworkIDTo>
<NetworkNameTo>string</NetworkNameTo>
<MailboxIDTo>int</MailboxIDTo>
<Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary or PEPPOL</Standard>
<Bytes>int</Bytes>
<InterchangeControlID>string</InterchangeControlID>
<InterchangeDateTime>dateTime</InterchangeDateTime>
<ArchiveDate>dateTime</ArchiveDate>
<StatusDate>dateTime</StatusDate>
<StatusCode>string</StatusCode>
<StatusMessage>string</StatusMessage>
<DocumentType>string</DocumentType>
<Header>string</Header>
<TPFrom xsi:nil="true" />
<TPTo xsi:nil="true" />
<Parcels xsi:nil="true" />
</InterchangeIDInfo>
<InterchangeIDInfo>
<InterchangeID>long</InterchangeID>
<InterchangeProcessDate>dateTime</InterchangeProcessDate>
<NetworkIDFrom>int</NetworkIDFrom>
<NetworkNameFrom>string</NetworkNameFrom>
<MailboxIDFrom>int</MailboxIDFrom>
<NetworkIDTo>int</NetworkIDTo>
<NetworkNameTo>string</NetworkNameTo>
<MailboxIDTo>int</MailboxIDTo>
<Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary or PEPPOL</Standard>
<Bytes>int</Bytes>
<InterchangeControlID>string</InterchangeControlID>
<InterchangeDateTime>dateTime</InterchangeDateTime>
<ArchiveDate>dateTime</ArchiveDate>
<StatusDate>dateTime</StatusDate>
<StatusCode>string</StatusCode>
<StatusMessage>string</StatusMessage>
<DocumentType>string</DocumentType>
<Header>string</Header>
<TPFrom xsi:nil="true" />
<TPTo xsi:nil="true" />
<Parcels xsi:nil="true" />
</InterchangeIDInfo>
</InterchangeIDInfoList>
</InterchangeOutBoxArchiveExResult>
</InterchangeOutBoxArchiveExResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /v4.1/prod/ecgridos.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<InterchangeOutBoxArchiveEx xmlns="https://os.ecgrid.io/">
<SessionID>string</SessionID>
<NetworkID>int</NetworkID>
<MailboxID>int</MailboxID>
<BeginDate>dateTime</BeginDate>
<EndDate>dateTime</EndDate>
<ECGridIDFrom>int</ECGridIDFrom>
<ECGridIDTo>int</ECGridIDTo>
<InterchangeControlID>string</InterchangeControlID>
<PageNo>short</PageNo>
<RecordsPerPage>short</RecordsPerPage>
</InterchangeOutBoxArchiveEx>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<InterchangeOutBoxArchiveExResponse xmlns="https://os.ecgrid.io/">
<InterchangeOutBoxArchiveExResult>
<PageSize>short</PageSize>
<PageNumber>short</PageNumber>
<Count>int</Count>
<TotalRecords>int</TotalRecords>
<TotalPages>short</TotalPages>
<InterchangeIDInfoList>
<InterchangeIDInfo>
<InterchangeID>long</InterchangeID>
<InterchangeProcessDate>dateTime</InterchangeProcessDate>
<NetworkIDFrom>int</NetworkIDFrom>
<NetworkNameFrom>string</NetworkNameFrom>
<MailboxIDFrom>int</MailboxIDFrom>
<NetworkIDTo>int</NetworkIDTo>
<NetworkNameTo>string</NetworkNameTo>
<MailboxIDTo>int</MailboxIDTo>
<Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary or PEPPOL</Standard>
<Bytes>int</Bytes>
<InterchangeControlID>string</InterchangeControlID>
<InterchangeDateTime>dateTime</InterchangeDateTime>
<ArchiveDate>dateTime</ArchiveDate>
<StatusDate>dateTime</StatusDate>
<StatusCode>string</StatusCode>
<StatusMessage>string</StatusMessage>
<DocumentType>string</DocumentType>
<Header>string</Header>
<TPFrom xsi:nil="true" />
<TPTo xsi:nil="true" />
<Parcels xsi:nil="true" />
</InterchangeIDInfo>
<InterchangeIDInfo>
<InterchangeID>long</InterchangeID>
<InterchangeProcessDate>dateTime</InterchangeProcessDate>
<NetworkIDFrom>int</NetworkIDFrom>
<NetworkNameFrom>string</NetworkNameFrom>
<MailboxIDFrom>int</MailboxIDFrom>
<NetworkIDTo>int</NetworkIDTo>
<NetworkNameTo>string</NetworkNameTo>
<MailboxIDTo>int</MailboxIDTo>
<Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary or PEPPOL</Standard>
<Bytes>int</Bytes>
<InterchangeControlID>string</InterchangeControlID>
<InterchangeDateTime>dateTime</InterchangeDateTime>
<ArchiveDate>dateTime</ArchiveDate>
<StatusDate>dateTime</StatusDate>
<StatusCode>string</StatusCode>
<StatusMessage>string</StatusMessage>
<DocumentType>string</DocumentType>
<Header>string</Header>
<TPFrom xsi:nil="true" />
<TPTo xsi:nil="true" />
<Parcels xsi:nil="true" />
</InterchangeIDInfo>
</InterchangeIDInfoList>
</InterchangeOutBoxArchiveExResult>
</InterchangeOutBoxArchiveExResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /v4.1/prod/ecgridos.asmx/InterchangeOutBoxArchiveEx?SessionID=string&NetworkID=string&MailboxID=string&BeginDate=string&EndDate=string&ECGridIDFrom=string&ECGridIDTo=string&InterchangeControlID=string&PageNo=string&RecordsPerPage=string HTTP/1.1 Host: os.ecgrid.io
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<InterchangeIDInfoCollection xmlns="https://os.ecgrid.io/">
<PageSize>short</PageSize>
<PageNumber>short</PageNumber>
<Count>int</Count>
<TotalRecords>int</TotalRecords>
<TotalPages>short</TotalPages>
<InterchangeIDInfoList>
<InterchangeIDInfo>
<InterchangeID>long</InterchangeID>
<InterchangeProcessDate>dateTime</InterchangeProcessDate>
<NetworkIDFrom>int</NetworkIDFrom>
<NetworkNameFrom>string</NetworkNameFrom>
<MailboxIDFrom>int</MailboxIDFrom>
<NetworkIDTo>int</NetworkIDTo>
<NetworkNameTo>string</NetworkNameTo>
<MailboxIDTo>int</MailboxIDTo>
<Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary or PEPPOL</Standard>
<Bytes>int</Bytes>
<InterchangeControlID>string</InterchangeControlID>
<InterchangeDateTime>dateTime</InterchangeDateTime>
<ArchiveDate>dateTime</ArchiveDate>
<StatusDate>dateTime</StatusDate>
<StatusCode>string</StatusCode>
<StatusMessage>string</StatusMessage>
<DocumentType>string</DocumentType>
<Header>string</Header>
<TPFrom>
<ECGridID>int</ECGridID>
<NetworkID>int</NetworkID>
<NetworkName>string</NetworkName>
<MailboxID>int</MailboxID>
<MailboxName>string</MailboxName>
<Qualifier>string</Qualifier>
<ID>string</ID>
<Description>string</Description>
<DataEMail>string</DataEMail>
<MailboxDefault>boolean</MailboxDefault>
<Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
<UseType>Undefined or Test or Production or TestAndProduction</UseType>
<Owner d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<OwnerInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Config d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</TPFrom>
<TPTo>
<ECGridID>int</ECGridID>
<NetworkID>int</NetworkID>
<NetworkName>string</NetworkName>
<MailboxID>int</MailboxID>
<MailboxName>string</MailboxName>
<Qualifier>string</Qualifier>
<ID>string</ID>
<Description>string</Description>
<DataEMail>string</DataEMail>
<MailboxDefault>boolean</MailboxDefault>
<Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
<UseType>Undefined or Test or Production or TestAndProduction</UseType>
<Owner d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<OwnerInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Config d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</TPTo>
<Parcels>
<ParcelIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ParcelIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Parcels>
</InterchangeIDInfo>
<InterchangeIDInfo>
<InterchangeID>long</InterchangeID>
<InterchangeProcessDate>dateTime</InterchangeProcessDate>
<NetworkIDFrom>int</NetworkIDFrom>
<NetworkNameFrom>string</NetworkNameFrom>
<MailboxIDFrom>int</MailboxIDFrom>
<NetworkIDTo>int</NetworkIDTo>
<NetworkNameTo>string</NetworkNameTo>
<MailboxIDTo>int</MailboxIDTo>
<Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary or PEPPOL</Standard>
<Bytes>int</Bytes>
<InterchangeControlID>string</InterchangeControlID>
<InterchangeDateTime>dateTime</InterchangeDateTime>
<ArchiveDate>dateTime</ArchiveDate>
<StatusDate>dateTime</StatusDate>
<StatusCode>string</StatusCode>
<StatusMessage>string</StatusMessage>
<DocumentType>string</DocumentType>
<Header>string</Header>
<TPFrom>
<ECGridID>int</ECGridID>
<NetworkID>int</NetworkID>
<NetworkName>string</NetworkName>
<MailboxID>int</MailboxID>
<MailboxName>string</MailboxName>
<Qualifier>string</Qualifier>
<ID>string</ID>
<Description>string</Description>
<DataEMail>string</DataEMail>
<MailboxDefault>boolean</MailboxDefault>
<Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
<UseType>Undefined or Test or Production or TestAndProduction</UseType>
<Owner d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<OwnerInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Config d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</TPFrom>
<TPTo>
<ECGridID>int</ECGridID>
<NetworkID>int</NetworkID>
<NetworkName>string</NetworkName>
<MailboxID>int</MailboxID>
<MailboxName>string</MailboxName>
<Qualifier>string</Qualifier>
<ID>string</ID>
<Description>string</Description>
<DataEMail>string</DataEMail>
<MailboxDefault>boolean</MailboxDefault>
<Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
<UseType>Undefined or Test or Production or TestAndProduction</UseType>
<Owner d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<OwnerInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Config d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</TPTo>
<Parcels>
<ParcelIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ParcelIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Parcels>
</InterchangeIDInfo>
</InterchangeIDInfoList>
</InterchangeIDInfoCollection>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /v4.1/prod/ecgridos.asmx/InterchangeOutBoxArchiveEx HTTP/1.1 Host: os.ecgrid.io Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&NetworkID=string&MailboxID=string&BeginDate=string&EndDate=string&ECGridIDFrom=string&ECGridIDTo=string&InterchangeControlID=string&PageNo=string&RecordsPerPage=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<InterchangeIDInfoCollection xmlns="https://os.ecgrid.io/">
<PageSize>short</PageSize>
<PageNumber>short</PageNumber>
<Count>int</Count>
<TotalRecords>int</TotalRecords>
<TotalPages>short</TotalPages>
<InterchangeIDInfoList>
<InterchangeIDInfo>
<InterchangeID>long</InterchangeID>
<InterchangeProcessDate>dateTime</InterchangeProcessDate>
<NetworkIDFrom>int</NetworkIDFrom>
<NetworkNameFrom>string</NetworkNameFrom>
<MailboxIDFrom>int</MailboxIDFrom>
<NetworkIDTo>int</NetworkIDTo>
<NetworkNameTo>string</NetworkNameTo>
<MailboxIDTo>int</MailboxIDTo>
<Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary or PEPPOL</Standard>
<Bytes>int</Bytes>
<InterchangeControlID>string</InterchangeControlID>
<InterchangeDateTime>dateTime</InterchangeDateTime>
<ArchiveDate>dateTime</ArchiveDate>
<StatusDate>dateTime</StatusDate>
<StatusCode>string</StatusCode>
<StatusMessage>string</StatusMessage>
<DocumentType>string</DocumentType>
<Header>string</Header>
<TPFrom>
<ECGridID>int</ECGridID>
<NetworkID>int</NetworkID>
<NetworkName>string</NetworkName>
<MailboxID>int</MailboxID>
<MailboxName>string</MailboxName>
<Qualifier>string</Qualifier>
<ID>string</ID>
<Description>string</Description>
<DataEMail>string</DataEMail>
<MailboxDefault>boolean</MailboxDefault>
<Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
<UseType>Undefined or Test or Production or TestAndProduction</UseType>
<Owner d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<OwnerInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Config d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</TPFrom>
<TPTo>
<ECGridID>int</ECGridID>
<NetworkID>int</NetworkID>
<NetworkName>string</NetworkName>
<MailboxID>int</MailboxID>
<MailboxName>string</MailboxName>
<Qualifier>string</Qualifier>
<ID>string</ID>
<Description>string</Description>
<DataEMail>string</DataEMail>
<MailboxDefault>boolean</MailboxDefault>
<Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
<UseType>Undefined or Test or Production or TestAndProduction</UseType>
<Owner d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<OwnerInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Config d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</TPTo>
<Parcels>
<ParcelIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ParcelIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Parcels>
</InterchangeIDInfo>
<InterchangeIDInfo>
<InterchangeID>long</InterchangeID>
<InterchangeProcessDate>dateTime</InterchangeProcessDate>
<NetworkIDFrom>int</NetworkIDFrom>
<NetworkNameFrom>string</NetworkNameFrom>
<MailboxIDFrom>int</MailboxIDFrom>
<NetworkIDTo>int</NetworkIDTo>
<NetworkNameTo>string</NetworkNameTo>
<MailboxIDTo>int</MailboxIDTo>
<Standard>X12 or EDIFACT or TRADACOMS or VDA or XML or TXT or PDF or Binary or PEPPOL</Standard>
<Bytes>int</Bytes>
<InterchangeControlID>string</InterchangeControlID>
<InterchangeDateTime>dateTime</InterchangeDateTime>
<ArchiveDate>dateTime</ArchiveDate>
<StatusDate>dateTime</StatusDate>
<StatusCode>string</StatusCode>
<StatusMessage>string</StatusMessage>
<DocumentType>string</DocumentType>
<Header>string</Header>
<TPFrom>
<ECGridID>int</ECGridID>
<NetworkID>int</NetworkID>
<NetworkName>string</NetworkName>
<MailboxID>int</MailboxID>
<MailboxName>string</MailboxName>
<Qualifier>string</Qualifier>
<ID>string</ID>
<Description>string</Description>
<DataEMail>string</DataEMail>
<MailboxDefault>boolean</MailboxDefault>
<Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
<UseType>Undefined or Test or Production or TestAndProduction</UseType>
<Owner d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<OwnerInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Config d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</TPFrom>
<TPTo>
<ECGridID>int</ECGridID>
<NetworkID>int</NetworkID>
<NetworkName>string</NetworkName>
<MailboxID>int</MailboxID>
<MailboxName>string</MailboxName>
<Qualifier>string</Qualifier>
<ID>string</ID>
<Description>string</Description>
<DataEMail>string</DataEMail>
<MailboxDefault>boolean</MailboxDefault>
<Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
<UseType>Undefined or Test or Production or TestAndProduction</UseType>
<Owner d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<OwnerInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Config d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</TPTo>
<Parcels>
<ParcelIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ParcelIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Parcels>
</InterchangeIDInfo>
</InterchangeIDInfoList>
</InterchangeIDInfoCollection>