Skip to content

InterchangeManifest

Jump to bottom
Lee Bolgatz edited this page Oct 28, 2022 · 2 revisions

Back To Common API Calls

A complete end-to-end transaction Manifest for a specific Interchange.

  public ManifestInfo[] InterchangeManifest(string SessionID,
                                            long InterchangeID)

Parameters

Returns

ManifestInfo[]

Code Example

C#

using System.Xml;
using System.Web.Services.Protocols;
using ECGridService = <ProjectName>.net.ecgridos;

try
{
    using (ECGridService.ECGridOSAPIv3 ECGrid = new ECGridService.ECGridOSAPIv3())
    {
        try
        {
            string SessionID = "00000000-0000-0000-0000-000000000000";
            int InterchangeID = 461;

            ECGridService.ManifestInfo[] InterchangeManifestsReturned = ECGrid.InterchangeManifest(SessionID, InterchangeID);

            foreach (var Manifest in InterchangeManifestsReturned)
            {
                Console.WriteLine(Manifest.Type);
                Console.WriteLine(Manifest.StatusMessage);
                Console.WriteLine(Manifest.ParcelID);
            }

        }
        catch (SoapException SoapEx)
        {
            // See SOAP Exceptions in the Appendix
            var ECG_Ex = CatchException(SoapEx);
            Console.WriteLine($"ECGridOS Soap Exception: {ECG_Ex.ErrorCode} , Item: {ECG_Ex.ErrorItem}, Message: {ECG_Ex.ErrorMessage}, String: {ECG_Ex.ErrorString}");
        }
    } // END USING
}
catch (Exception ex){ Console.WriteLine("Unhandled Exception: " + ex.ToString()); }

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/InterchangeManifest"

<?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>
    <InterchangeManifest xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <InterchangeID>long</InterchangeID>
    </InterchangeManifest>
  </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>
    <InterchangeManifestResponse xmlns="https://os.ecgrid.io/">
      <InterchangeManifestResult>
        <ManifestInfo>
          <ManifestDate>dateTime</ManifestDate>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Type>System or Error or Manual or ECGridOS</Type>
          <ParcelID>long</ParcelID>
          <InterchangeID>long</InterchangeID>
          <StatusCode>string</StatusCode>
          <StatusMessage>string</StatusMessage>
          <StatusColor>string</StatusColor>
        </ManifestInfo>
        <ManifestInfo>
          <ManifestDate>dateTime</ManifestDate>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Type>System or Error or Manual or ECGridOS</Type>
          <ParcelID>long</ParcelID>
          <InterchangeID>long</InterchangeID>
          <StatusCode>string</StatusCode>
          <StatusMessage>string</StatusMessage>
          <StatusColor>string</StatusColor>
        </ManifestInfo>
      </InterchangeManifestResult>
    </InterchangeManifestResponse>
  </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>
    <InterchangeManifest xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <InterchangeID>long</InterchangeID>
    </InterchangeManifest>
  </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>
    <InterchangeManifestResponse xmlns="https://os.ecgrid.io/">
      <InterchangeManifestResult>
        <ManifestInfo>
          <ManifestDate>dateTime</ManifestDate>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Type>System or Error or Manual or ECGridOS</Type>
          <ParcelID>long</ParcelID>
          <InterchangeID>long</InterchangeID>
          <StatusCode>string</StatusCode>
          <StatusMessage>string</StatusMessage>
          <StatusColor>string</StatusColor>
        </ManifestInfo>
        <ManifestInfo>
          <ManifestDate>dateTime</ManifestDate>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Type>System or Error or Manual or ECGridOS</Type>
          <ParcelID>long</ParcelID>
          <InterchangeID>long</InterchangeID>
          <StatusCode>string</StatusCode>
          <StatusMessage>string</StatusMessage>
          <StatusColor>string</StatusColor>
        </ManifestInfo>
      </InterchangeManifestResult>
    </InterchangeManifestResponse>
  </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/InterchangeManifest?SessionID=string&InterchangeID=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"?>
<ArrayOfManifestInfo xmlns="https://os.ecgrid.io/">
  <ManifestInfo>
    <ManifestDate>dateTime</ManifestDate>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Type>System or Error or Manual or ECGridOS</Type>
    <ParcelID>long</ParcelID>
    <InterchangeID>long</InterchangeID>
    <StatusCode>string</StatusCode>
    <StatusMessage>string</StatusMessage>
    <StatusColor>string</StatusColor>
  </ManifestInfo>
  <ManifestInfo>
    <ManifestDate>dateTime</ManifestDate>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Type>System or Error or Manual or ECGridOS</Type>
    <ParcelID>long</ParcelID>
    <InterchangeID>long</InterchangeID>
    <StatusCode>string</StatusCode>
    <StatusMessage>string</StatusMessage>
    <StatusColor>string</StatusColor>
  </ManifestInfo>
</ArrayOfManifestInfo>

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/InterchangeManifest HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&InterchangeID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfManifestInfo xmlns="https://os.ecgrid.io/">
  <ManifestInfo>
    <ManifestDate>dateTime</ManifestDate>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Type>System or Error or Manual or ECGridOS</Type>
    <ParcelID>long</ParcelID>
    <InterchangeID>long</InterchangeID>
    <StatusCode>string</StatusCode>
    <StatusMessage>string</StatusMessage>
    <StatusColor>string</StatusColor>
  </ManifestInfo>
  <ManifestInfo>
    <ManifestDate>dateTime</ManifestDate>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Type>System or Error or Manual or ECGridOS</Type>
    <ParcelID>long</ParcelID>
    <InterchangeID>long</InterchangeID>
    <StatusCode>string</StatusCode>
    <StatusMessage>string</StatusMessage>
    <StatusColor>string</StatusColor>
  </ManifestInfo>
</ArrayOfManifestInfo>

Back To Common API Calls

Home

Getting Started

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally