ECGridOS API v4
Click here for a complete list of operations.
InterchangeHeaderInfo
Get Interchange Info from EDI Envelope (ISA or UNB).
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/InterchangeHeaderInfo" <?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> <InterchangeHeaderInfo xmlns="https://os.ecgrid.io/"> <SessionID>string</SessionID> <InterchangeHeader>string</InterchangeHeader> </InterchangeHeaderInfo> </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> <InterchangeHeaderInfoResponse xmlns="https://os.ecgrid.io/"> <InterchangeHeaderInfoResult> <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> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <EMail>string</EMail> <Phone>string</Phone> <CellPhone>string</CellPhone> <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </Owner> <OwnerInfo> <NetworkID>int</NetworkID> <NetworkName>string</NetworkName> <MailboxID>int</MailboxID> <MailboxName>string</MailboxName> <Created>dateTime</Created> <Modified>dateTime</Modified> <Effective>dateTime</Effective> <Expires>dateTime</Expires> <LastTraffic>dateTime</LastTraffic> <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup> </OwnerInfo> <Config> <InBoxTimeout>short</InBoxTimeout> <SegTerm>unsignedByte</SegTerm> <ElmSep>unsignedByte</ElmSep> <SubElmSep>unsignedByte</SubElmSep> <EBCDICFilter>short</EBCDICFilter> <FTPasciiFilter>boolean</FTPasciiFilter> <LowPassFilter>boolean</LowPassFilter> <MailbagPassThrough>boolean</MailbagPassThrough> <DeleteOnDownload>boolean</DeleteOnDownload> <StripDirectedEnvelope>boolean</StripDirectedEnvelope> </Config> </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> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <EMail>string</EMail> <Phone>string</Phone> <CellPhone>string</CellPhone> <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </Owner> <OwnerInfo> <NetworkID>int</NetworkID> <NetworkName>string</NetworkName> <MailboxID>int</MailboxID> <MailboxName>string</MailboxName> <Created>dateTime</Created> <Modified>dateTime</Modified> <Effective>dateTime</Effective> <Expires>dateTime</Expires> <LastTraffic>dateTime</LastTraffic> <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup> </OwnerInfo> <Config> <InBoxTimeout>short</InBoxTimeout> <SegTerm>unsignedByte</SegTerm> <ElmSep>unsignedByte</ElmSep> <SubElmSep>unsignedByte</SubElmSep> <EBCDICFilter>short</EBCDICFilter> <FTPasciiFilter>boolean</FTPasciiFilter> <LowPassFilter>boolean</LowPassFilter> <MailbagPassThrough>boolean</MailbagPassThrough> <DeleteOnDownload>boolean</DeleteOnDownload> <StripDirectedEnvelope>boolean</StripDirectedEnvelope> </Config> </TPTo> <Parcels> <ParcelIDInfo> <ParcelBytes>int</ParcelBytes> <ParcelDate>dateTime</ParcelDate> <ActualBytes>int</ActualBytes> <NetworkIDFrom>int</NetworkIDFrom> <NetworkNameFrom>string</NetworkNameFrom> <MailboxIDFrom>int</MailboxIDFrom> <MailboxNameFrom>string</MailboxNameFrom> <NetworkIDTo>int</NetworkIDTo> <NetworkNameTo>string</NetworkNameTo> <MailboxIDTo>int</MailboxIDTo> <MailboxNameTo>string</MailboxNameTo> <FileName>string</FileName> <MailbagControlID>string</MailbagControlID> <ArchiveDate>dateTime</ArchiveDate> <StatusDate>dateTime</StatusDate> <StatusCode>string</StatusCode> <StatusMessage>string</StatusMessage> <LocalStatus>short</LocalStatus> <LocalStatusDate>dateTime</LocalStatusDate> <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid> <Acknowledgment>string</Acknowledgment> <Direction>NoDir or OutBox or InBox</Direction> <Interchanges xsi:nil="true" /> <Log xsi:nil="true" /> <ParcelID>long</ParcelID> </ParcelIDInfo> <ParcelIDInfo> <ParcelBytes>int</ParcelBytes> <ParcelDate>dateTime</ParcelDate> <ActualBytes>int</ActualBytes> <NetworkIDFrom>int</NetworkIDFrom> <NetworkNameFrom>string</NetworkNameFrom> <MailboxIDFrom>int</MailboxIDFrom> <MailboxNameFrom>string</MailboxNameFrom> <NetworkIDTo>int</NetworkIDTo> <NetworkNameTo>string</NetworkNameTo> <MailboxIDTo>int</MailboxIDTo> <MailboxNameTo>string</MailboxNameTo> <FileName>string</FileName> <MailbagControlID>string</MailbagControlID> <ArchiveDate>dateTime</ArchiveDate> <StatusDate>dateTime</StatusDate> <StatusCode>string</StatusCode> <StatusMessage>string</StatusMessage> <LocalStatus>short</LocalStatus> <LocalStatusDate>dateTime</LocalStatusDate> <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid> <Acknowledgment>string</Acknowledgment> <Direction>NoDir or OutBox or InBox</Direction> <Interchanges xsi:nil="true" /> <Log xsi:nil="true" /> <ParcelID>long</ParcelID> </ParcelIDInfo> </Parcels> </InterchangeHeaderInfoResult> </InterchangeHeaderInfoResponse> </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> <InterchangeHeaderInfo xmlns="https://os.ecgrid.io/"> <SessionID>string</SessionID> <InterchangeHeader>string</InterchangeHeader> </InterchangeHeaderInfo> </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> <InterchangeHeaderInfoResponse xmlns="https://os.ecgrid.io/"> <InterchangeHeaderInfoResult> <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> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <EMail>string</EMail> <Phone>string</Phone> <CellPhone>string</CellPhone> <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </Owner> <OwnerInfo> <NetworkID>int</NetworkID> <NetworkName>string</NetworkName> <MailboxID>int</MailboxID> <MailboxName>string</MailboxName> <Created>dateTime</Created> <Modified>dateTime</Modified> <Effective>dateTime</Effective> <Expires>dateTime</Expires> <LastTraffic>dateTime</LastTraffic> <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup> </OwnerInfo> <Config> <InBoxTimeout>short</InBoxTimeout> <SegTerm>unsignedByte</SegTerm> <ElmSep>unsignedByte</ElmSep> <SubElmSep>unsignedByte</SubElmSep> <EBCDICFilter>short</EBCDICFilter> <FTPasciiFilter>boolean</FTPasciiFilter> <LowPassFilter>boolean</LowPassFilter> <MailbagPassThrough>boolean</MailbagPassThrough> <DeleteOnDownload>boolean</DeleteOnDownload> <StripDirectedEnvelope>boolean</StripDirectedEnvelope> </Config> </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> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <EMail>string</EMail> <Phone>string</Phone> <CellPhone>string</CellPhone> <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </Owner> <OwnerInfo> <NetworkID>int</NetworkID> <NetworkName>string</NetworkName> <MailboxID>int</MailboxID> <MailboxName>string</MailboxName> <Created>dateTime</Created> <Modified>dateTime</Modified> <Effective>dateTime</Effective> <Expires>dateTime</Expires> <LastTraffic>dateTime</LastTraffic> <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup> </OwnerInfo> <Config> <InBoxTimeout>short</InBoxTimeout> <SegTerm>unsignedByte</SegTerm> <ElmSep>unsignedByte</ElmSep> <SubElmSep>unsignedByte</SubElmSep> <EBCDICFilter>short</EBCDICFilter> <FTPasciiFilter>boolean</FTPasciiFilter> <LowPassFilter>boolean</LowPassFilter> <MailbagPassThrough>boolean</MailbagPassThrough> <DeleteOnDownload>boolean</DeleteOnDownload> <StripDirectedEnvelope>boolean</StripDirectedEnvelope> </Config> </TPTo> <Parcels> <ParcelIDInfo> <ParcelBytes>int</ParcelBytes> <ParcelDate>dateTime</ParcelDate> <ActualBytes>int</ActualBytes> <NetworkIDFrom>int</NetworkIDFrom> <NetworkNameFrom>string</NetworkNameFrom> <MailboxIDFrom>int</MailboxIDFrom> <MailboxNameFrom>string</MailboxNameFrom> <NetworkIDTo>int</NetworkIDTo> <NetworkNameTo>string</NetworkNameTo> <MailboxIDTo>int</MailboxIDTo> <MailboxNameTo>string</MailboxNameTo> <FileName>string</FileName> <MailbagControlID>string</MailbagControlID> <ArchiveDate>dateTime</ArchiveDate> <StatusDate>dateTime</StatusDate> <StatusCode>string</StatusCode> <StatusMessage>string</StatusMessage> <LocalStatus>short</LocalStatus> <LocalStatusDate>dateTime</LocalStatusDate> <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid> <Acknowledgment>string</Acknowledgment> <Direction>NoDir or OutBox or InBox</Direction> <Interchanges xsi:nil="true" /> <Log xsi:nil="true" /> <ParcelID>long</ParcelID> </ParcelIDInfo> <ParcelIDInfo> <ParcelBytes>int</ParcelBytes> <ParcelDate>dateTime</ParcelDate> <ActualBytes>int</ActualBytes> <NetworkIDFrom>int</NetworkIDFrom> <NetworkNameFrom>string</NetworkNameFrom> <MailboxIDFrom>int</MailboxIDFrom> <MailboxNameFrom>string</MailboxNameFrom> <NetworkIDTo>int</NetworkIDTo> <NetworkNameTo>string</NetworkNameTo> <MailboxIDTo>int</MailboxIDTo> <MailboxNameTo>string</MailboxNameTo> <FileName>string</FileName> <MailbagControlID>string</MailbagControlID> <ArchiveDate>dateTime</ArchiveDate> <StatusDate>dateTime</StatusDate> <StatusCode>string</StatusCode> <StatusMessage>string</StatusMessage> <LocalStatus>short</LocalStatus> <LocalStatusDate>dateTime</LocalStatusDate> <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid> <Acknowledgment>string</Acknowledgment> <Direction>NoDir or OutBox or InBox</Direction> <Interchanges xsi:nil="true" /> <Log xsi:nil="true" /> <ParcelID>long</ParcelID> </ParcelIDInfo> </Parcels> </InterchangeHeaderInfoResult> </InterchangeHeaderInfoResponse> </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/InterchangeHeaderInfo?SessionID=string&InterchangeHeader=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"?> <InterchangeIDInfo xmlns="https://os.ecgrid.io/"> <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> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <EMail>string</EMail> <Phone>string</Phone> <CellPhone>string</CellPhone> <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </Owner> <OwnerInfo> <NetworkID>int</NetworkID> <NetworkName>string</NetworkName> <MailboxID>int</MailboxID> <MailboxName>string</MailboxName> <Created>dateTime</Created> <Modified>dateTime</Modified> <Effective>dateTime</Effective> <Expires>dateTime</Expires> <LastTraffic>dateTime</LastTraffic> <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup> </OwnerInfo> <Config> <InBoxTimeout>short</InBoxTimeout> <SegTerm>unsignedByte</SegTerm> <ElmSep>unsignedByte</ElmSep> <SubElmSep>unsignedByte</SubElmSep> <EBCDICFilter>short</EBCDICFilter> <FTPasciiFilter>boolean</FTPasciiFilter> <LowPassFilter>boolean</LowPassFilter> <MailbagPassThrough>boolean</MailbagPassThrough> <DeleteOnDownload>boolean</DeleteOnDownload> <StripDirectedEnvelope>boolean</StripDirectedEnvelope> </Config> </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> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <EMail>string</EMail> <Phone>string</Phone> <CellPhone>string</CellPhone> <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </Owner> <OwnerInfo> <NetworkID>int</NetworkID> <NetworkName>string</NetworkName> <MailboxID>int</MailboxID> <MailboxName>string</MailboxName> <Created>dateTime</Created> <Modified>dateTime</Modified> <Effective>dateTime</Effective> <Expires>dateTime</Expires> <LastTraffic>dateTime</LastTraffic> <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup> </OwnerInfo> <Config> <InBoxTimeout>short</InBoxTimeout> <SegTerm>unsignedByte</SegTerm> <ElmSep>unsignedByte</ElmSep> <SubElmSep>unsignedByte</SubElmSep> <EBCDICFilter>short</EBCDICFilter> <FTPasciiFilter>boolean</FTPasciiFilter> <LowPassFilter>boolean</LowPassFilter> <MailbagPassThrough>boolean</MailbagPassThrough> <DeleteOnDownload>boolean</DeleteOnDownload> <StripDirectedEnvelope>boolean</StripDirectedEnvelope> </Config> </TPTo> <Parcels> <ParcelIDInfo> <ParcelBytes>int</ParcelBytes> <ParcelDate>dateTime</ParcelDate> <ActualBytes>int</ActualBytes> <NetworkIDFrom>int</NetworkIDFrom> <NetworkNameFrom>string</NetworkNameFrom> <MailboxIDFrom>int</MailboxIDFrom> <MailboxNameFrom>string</MailboxNameFrom> <NetworkIDTo>int</NetworkIDTo> <NetworkNameTo>string</NetworkNameTo> <MailboxIDTo>int</MailboxIDTo> <MailboxNameTo>string</MailboxNameTo> <FileName>string</FileName> <MailbagControlID>string</MailbagControlID> <ArchiveDate>dateTime</ArchiveDate> <StatusDate>dateTime</StatusDate> <StatusCode>string</StatusCode> <StatusMessage>string</StatusMessage> <LocalStatus>short</LocalStatus> <LocalStatusDate>dateTime</LocalStatusDate> <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid> <Acknowledgment>string</Acknowledgment> <Direction>NoDir or OutBox or InBox</Direction> <Interchanges> <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Interchanges> <Log> <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Log> <ParcelID>long</ParcelID> </ParcelIDInfo> <ParcelIDInfo> <ParcelBytes>int</ParcelBytes> <ParcelDate>dateTime</ParcelDate> <ActualBytes>int</ActualBytes> <NetworkIDFrom>int</NetworkIDFrom> <NetworkNameFrom>string</NetworkNameFrom> <MailboxIDFrom>int</MailboxIDFrom> <MailboxNameFrom>string</MailboxNameFrom> <NetworkIDTo>int</NetworkIDTo> <NetworkNameTo>string</NetworkNameTo> <MailboxIDTo>int</MailboxIDTo> <MailboxNameTo>string</MailboxNameTo> <FileName>string</FileName> <MailbagControlID>string</MailbagControlID> <ArchiveDate>dateTime</ArchiveDate> <StatusDate>dateTime</StatusDate> <StatusCode>string</StatusCode> <StatusMessage>string</StatusMessage> <LocalStatus>short</LocalStatus> <LocalStatusDate>dateTime</LocalStatusDate> <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid> <Acknowledgment>string</Acknowledgment> <Direction>NoDir or OutBox or InBox</Direction> <Interchanges> <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Interchanges> <Log> <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Log> <ParcelID>long</ParcelID> </ParcelIDInfo> </Parcels> </InterchangeIDInfo>
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/InterchangeHeaderInfo HTTP/1.1 Host: os.ecgrid.io Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&InterchangeHeader=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <InterchangeIDInfo xmlns="https://os.ecgrid.io/"> <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> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <EMail>string</EMail> <Phone>string</Phone> <CellPhone>string</CellPhone> <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </Owner> <OwnerInfo> <NetworkID>int</NetworkID> <NetworkName>string</NetworkName> <MailboxID>int</MailboxID> <MailboxName>string</MailboxName> <Created>dateTime</Created> <Modified>dateTime</Modified> <Effective>dateTime</Effective> <Expires>dateTime</Expires> <LastTraffic>dateTime</LastTraffic> <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup> </OwnerInfo> <Config> <InBoxTimeout>short</InBoxTimeout> <SegTerm>unsignedByte</SegTerm> <ElmSep>unsignedByte</ElmSep> <SubElmSep>unsignedByte</SubElmSep> <EBCDICFilter>short</EBCDICFilter> <FTPasciiFilter>boolean</FTPasciiFilter> <LowPassFilter>boolean</LowPassFilter> <MailbagPassThrough>boolean</MailbagPassThrough> <DeleteOnDownload>boolean</DeleteOnDownload> <StripDirectedEnvelope>boolean</StripDirectedEnvelope> </Config> </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> <UserID>int</UserID> <LoginName>string</LoginName> <RecoveryQuestion>string</RecoveryQuestion> <FirstName>string</FirstName> <LastName>string</LastName> <Company>string</Company> <EMail>string</EMail> <Phone>string</Phone> <CellPhone>string</CellPhone> <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier> <TimeZoneOffset>short</TimeZoneOffset> <NetworkID>int</NetworkID> <MailboxID>int</MailboxID> <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel> <Created>dateTime</Created> <Modified>dateTime</Modified> <LastLogin>dateTime</LastLogin> <Status>Development or Active or Preproduction or Suspended or Terminated</Status> <LockedOut>boolean</LockedOut> <OpenSessions>short</OpenSessions> </Owner> <OwnerInfo> <NetworkID>int</NetworkID> <NetworkName>string</NetworkName> <MailboxID>int</MailboxID> <MailboxName>string</MailboxName> <Created>dateTime</Created> <Modified>dateTime</Modified> <Effective>dateTime</Effective> <Expires>dateTime</Expires> <LastTraffic>dateTime</LastTraffic> <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup> </OwnerInfo> <Config> <InBoxTimeout>short</InBoxTimeout> <SegTerm>unsignedByte</SegTerm> <ElmSep>unsignedByte</ElmSep> <SubElmSep>unsignedByte</SubElmSep> <EBCDICFilter>short</EBCDICFilter> <FTPasciiFilter>boolean</FTPasciiFilter> <LowPassFilter>boolean</LowPassFilter> <MailbagPassThrough>boolean</MailbagPassThrough> <DeleteOnDownload>boolean</DeleteOnDownload> <StripDirectedEnvelope>boolean</StripDirectedEnvelope> </Config> </TPTo> <Parcels> <ParcelIDInfo> <ParcelBytes>int</ParcelBytes> <ParcelDate>dateTime</ParcelDate> <ActualBytes>int</ActualBytes> <NetworkIDFrom>int</NetworkIDFrom> <NetworkNameFrom>string</NetworkNameFrom> <MailboxIDFrom>int</MailboxIDFrom> <MailboxNameFrom>string</MailboxNameFrom> <NetworkIDTo>int</NetworkIDTo> <NetworkNameTo>string</NetworkNameTo> <MailboxIDTo>int</MailboxIDTo> <MailboxNameTo>string</MailboxNameTo> <FileName>string</FileName> <MailbagControlID>string</MailbagControlID> <ArchiveDate>dateTime</ArchiveDate> <StatusDate>dateTime</StatusDate> <StatusCode>string</StatusCode> <StatusMessage>string</StatusMessage> <LocalStatus>short</LocalStatus> <LocalStatusDate>dateTime</LocalStatusDate> <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid> <Acknowledgment>string</Acknowledgment> <Direction>NoDir or OutBox or InBox</Direction> <Interchanges> <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Interchanges> <Log> <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Log> <ParcelID>long</ParcelID> </ParcelIDInfo> <ParcelIDInfo> <ParcelBytes>int</ParcelBytes> <ParcelDate>dateTime</ParcelDate> <ActualBytes>int</ActualBytes> <NetworkIDFrom>int</NetworkIDFrom> <NetworkNameFrom>string</NetworkNameFrom> <MailboxIDFrom>int</MailboxIDFrom> <MailboxNameFrom>string</MailboxNameFrom> <NetworkIDTo>int</NetworkIDTo> <NetworkNameTo>string</NetworkNameTo> <MailboxIDTo>int</MailboxIDTo> <MailboxNameTo>string</MailboxNameTo> <FileName>string</FileName> <MailbagControlID>string</MailbagControlID> <ArchiveDate>dateTime</ArchiveDate> <StatusDate>dateTime</StatusDate> <StatusCode>string</StatusCode> <StatusMessage>string</StatusMessage> <LocalStatus>short</LocalStatus> <LocalStatusDate>dateTime</LocalStatusDate> <Valid>Pending or Invalid or Valid or PartialValid or ValidNoneRouted or Duplicate or ZeroByte or VallidRouted or ValidPartialRouted or ValidNoneRoutedx</Valid> <Acknowledgment>string</Acknowledgment> <Direction>NoDir or OutBox or InBox</Direction> <Interchanges> <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <InterchangeIDInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Interchanges> <Log> <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <ManifestInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Log> <ParcelID>long</ParcelID> </ParcelIDInfo> </Parcels> </InterchangeIDInfo>