ParcelNoteList

Greg Kolinski edited this page Sep 21, 2017 · 1 revision

Back To Common API Calls


List the system generated Notes for a Parcel.

  public ParcelNote[] ParcelNoteList(string SessionID, long ParcelID)

Parameters:


Returns

ParcelNote


Remarks

When an exception occurs in the processing of a Parcel, a note is entered into the system automatically or by ECGrid NetOps. This method is helpful in diagnosing OutBox errors.

Most Parcels will not have any Notes associated with them. See ParcelManifest() for normal processing information.


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 ParcelID = 56845;

            ECGridService.ParcelNote[] ParcelNoteResults = ECGrid.ParcelNoteList(SessionID, ParcelID);

            foreach (var ParcelNote in ParcelNoteResults)
            {
                Console.WriteLine(ParcelNote.StatusCode);
                Console.WriteLine(ParcelNote.Note);
            }

        }
        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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/ParcelNoteList"

<?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>
    <ParcelNoteList xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <ParcelID>long</ParcelID>
    </ParcelNoteList>
  </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>
    <ParcelNoteListResponse xmlns="http://ecgridos.net/">
      <ParcelNoteListResult>
        <ParcelNote>
          <ParcelID>long</ParcelID>
          <ParcelNoteID>int</ParcelNoteID>
          <InterchangeID>long</InterchangeID>
          <NoteDate>dateTime</NoteDate>
          <StatusCode>string</StatusCode>
          <PostedBy>string</PostedBy>
          <UserID>int</UserID>
          <Note>string</Note>
        </ParcelNote>
        <ParcelNote>
          <ParcelID>long</ParcelID>
          <ParcelNoteID>int</ParcelNoteID>
          <InterchangeID>long</InterchangeID>
          <NoteDate>dateTime</NoteDate>
          <StatusCode>string</StatusCode>
          <PostedBy>string</PostedBy>
          <UserID>int</UserID>
          <Note>string</Note>
        </ParcelNote>
      </ParcelNoteListResult>
    </ParcelNoteListResponse>
  </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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
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>
    <ParcelNoteList xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <ParcelID>long</ParcelID>
    </ParcelNoteList>
  </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>
    <ParcelNoteListResponse xmlns="http://ecgridos.net/">
      <ParcelNoteListResult>
        <ParcelNote>
          <ParcelID>long</ParcelID>
          <ParcelNoteID>int</ParcelNoteID>
          <InterchangeID>long</InterchangeID>
          <NoteDate>dateTime</NoteDate>
          <StatusCode>string</StatusCode>
          <PostedBy>string</PostedBy>
          <UserID>int</UserID>
          <Note>string</Note>
        </ParcelNote>
        <ParcelNote>
          <ParcelID>long</ParcelID>
          <ParcelNoteID>int</ParcelNoteID>
          <InterchangeID>long</InterchangeID>
          <NoteDate>dateTime</NoteDate>
          <StatusCode>string</StatusCode>
          <PostedBy>string</PostedBy>
          <UserID>int</UserID>
          <Note>string</Note>
        </ParcelNote>
      </ParcelNoteListResult>
    </ParcelNoteListResponse>
  </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 /v3.2/prod/ecgridos.asmx/ParcelNoteList?SessionID=string&ParcelID=string HTTP/1.1
Host: ecgridos.net
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfParcelNote xmlns="http://ecgridos.net/">
  <ParcelNote>
    <ParcelID>long</ParcelID>
    <ParcelNoteID>int</ParcelNoteID>
    <InterchangeID>long</InterchangeID>
    <NoteDate>dateTime</NoteDate>
    <StatusCode>string</StatusCode>
    <PostedBy>string</PostedBy>
    <UserID>int</UserID>
    <Note>string</Note>
  </ParcelNote>
  <ParcelNote>
    <ParcelID>long</ParcelID>
    <ParcelNoteID>int</ParcelNoteID>
    <InterchangeID>long</InterchangeID>
    <NoteDate>dateTime</NoteDate>
    <StatusCode>string</StatusCode>
    <PostedBy>string</PostedBy>
    <UserID>int</UserID>
    <Note>string</Note>
  </ParcelNote>
</ArrayOfParcelNote>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v3.2/prod/ecgridos.asmx/ParcelNoteList HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfParcelNote xmlns="http://ecgridos.net/">
  <ParcelNote>
    <ParcelID>long</ParcelID>
    <ParcelNoteID>int</ParcelNoteID>
    <InterchangeID>long</InterchangeID>
    <NoteDate>dateTime</NoteDate>
    <StatusCode>string</StatusCode>
    <PostedBy>string</PostedBy>
    <UserID>int</UserID>
    <Note>string</Note>
  </ParcelNote>
  <ParcelNote>
    <ParcelID>long</ParcelID>
    <ParcelNoteID>int</ParcelNoteID>
    <InterchangeID>long</InterchangeID>
    <NoteDate>dateTime</NoteDate>
    <StatusCode>string</StatusCode>
    <PostedBy>string</PostedBy>
    <UserID>int</UserID>
    <Note>string</Note>
  </ParcelNote>
</ArrayOfParcelNote>

Back To Common API Calls

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.