InterconnectNoteList

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

Back To Common API Calls


Notes for a specific Interconnect.

  public InterconnectNote[] InterconnectNoteList(string SessionID, int InterconnectID)

Parameters:


Returns

InterconnectNote[]


Remarks

A list of notes associated with the Interconnect Request. Notes can be appended to Interconnect Requests directly by InterconnectNote(), InterconnectUpdate() and InterconnectCancel().


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 InterconnectID = 44446786;

            ECGridService.InterconnectNote[] InterconnectNoteArray = ECGrid.InterconnectNoteList(SessionID, InterconnectID);

            foreach (var InterconnectNote in InterconnectNoteArray)
            {
                Console.WriteLine(InterconnectNote.InterconnectNoteID);
                Console.WriteLine(InterconnectNote.Note);
                Console.WriteLine(InterconnectNote.Status);
            }

        }
        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/InterconnectNoteList"

<?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>
    <InterconnectNoteList xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <InterconnectID>int</InterconnectID>
    </InterconnectNoteList>
  </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>
    <InterconnectNoteListResponse xmlns="http://ecgridos.net/">
      <InterconnectNoteListResult>
        <InterconnectNote>
          <InterconnectID>int</InterconnectID>
          <InterconnectNoteID>int</InterconnectNoteID>
          <NoteDate>dateTime</NoteDate>
          <Status>Pending or Completed or Canceled or Delayed or Problem or AuthorizationRequired or NoStatusChange</Status>
          <PostedBy>string</PostedBy>
          <UserID>int</UserID>
          <MailTo>string</MailTo>
          <Note>string</Note>
          <Attachment>
            <FileName>string</FileName>
            <Content>base64Binary</Content>
          </Attachment>
        </InterconnectNote>
        <InterconnectNote>
          <InterconnectID>int</InterconnectID>
          <InterconnectNoteID>int</InterconnectNoteID>
          <NoteDate>dateTime</NoteDate>
          <Status>Pending or Completed or Canceled or Delayed or Problem or AuthorizationRequired or NoStatusChange</Status>
          <PostedBy>string</PostedBy>
          <UserID>int</UserID>
          <MailTo>string</MailTo>
          <Note>string</Note>
          <Attachment>
            <FileName>string</FileName>
            <Content>base64Binary</Content>
          </Attachment>
        </InterconnectNote>
      </InterconnectNoteListResult>
    </InterconnectNoteListResponse>
  </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>
    <InterconnectNoteList xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <InterconnectID>int</InterconnectID>
    </InterconnectNoteList>
  </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>
    <InterconnectNoteListResponse xmlns="http://ecgridos.net/">
      <InterconnectNoteListResult>
        <InterconnectNote>
          <InterconnectID>int</InterconnectID>
          <InterconnectNoteID>int</InterconnectNoteID>
          <NoteDate>dateTime</NoteDate>
          <Status>Pending or Completed or Canceled or Delayed or Problem or AuthorizationRequired or NoStatusChange</Status>
          <PostedBy>string</PostedBy>
          <UserID>int</UserID>
          <MailTo>string</MailTo>
          <Note>string</Note>
          <Attachment>
            <FileName>string</FileName>
            <Content>base64Binary</Content>
          </Attachment>
        </InterconnectNote>
        <InterconnectNote>
          <InterconnectID>int</InterconnectID>
          <InterconnectNoteID>int</InterconnectNoteID>
          <NoteDate>dateTime</NoteDate>
          <Status>Pending or Completed or Canceled or Delayed or Problem or AuthorizationRequired or NoStatusChange</Status>
          <PostedBy>string</PostedBy>
          <UserID>int</UserID>
          <MailTo>string</MailTo>
          <Note>string</Note>
          <Attachment>
            <FileName>string</FileName>
            <Content>base64Binary</Content>
          </Attachment>
        </InterconnectNote>
      </InterconnectNoteListResult>
    </InterconnectNoteListResponse>
  </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/InterconnectNoteList?SessionID=string&InterconnectID=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"?>
<ArrayOfInterconnectNote xmlns="http://ecgridos.net/">
  <InterconnectNote>
    <InterconnectID>int</InterconnectID>
    <InterconnectNoteID>int</InterconnectNoteID>
    <NoteDate>dateTime</NoteDate>
    <Status>Pending or Completed or Canceled or Delayed or Problem or AuthorizationRequired or NoStatusChange</Status>
    <PostedBy>string</PostedBy>
    <UserID>int</UserID>
    <MailTo>string</MailTo>
    <Note>string</Note>
    <Attachment>
      <FileName>string</FileName>
      <Content>base64Binary</Content>
    </Attachment>
  </InterconnectNote>
  <InterconnectNote>
    <InterconnectID>int</InterconnectID>
    <InterconnectNoteID>int</InterconnectNoteID>
    <NoteDate>dateTime</NoteDate>
    <Status>Pending or Completed or Canceled or Delayed or Problem or AuthorizationRequired or NoStatusChange</Status>
    <PostedBy>string</PostedBy>
    <UserID>int</UserID>
    <MailTo>string</MailTo>
    <Note>string</Note>
    <Attachment>
      <FileName>string</FileName>
      <Content>base64Binary</Content>
    </Attachment>
  </InterconnectNote>
</ArrayOfInterconnectNote>

HTTP POST

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

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfInterconnectNote xmlns="http://ecgridos.net/">
  <InterconnectNote>
    <InterconnectID>int</InterconnectID>
    <InterconnectNoteID>int</InterconnectNoteID>
    <NoteDate>dateTime</NoteDate>
    <Status>Pending or Completed or Canceled or Delayed or Problem or AuthorizationRequired or NoStatusChange</Status>
    <PostedBy>string</PostedBy>
    <UserID>int</UserID>
    <MailTo>string</MailTo>
    <Note>string</Note>
    <Attachment>
      <FileName>string</FileName>
      <Content>base64Binary</Content>
    </Attachment>
  </InterconnectNote>
  <InterconnectNote>
    <InterconnectID>int</InterconnectID>
    <InterconnectNoteID>int</InterconnectNoteID>
    <NoteDate>dateTime</NoteDate>
    <Status>Pending or Completed or Canceled or Delayed or Problem or AuthorizationRequired or NoStatusChange</Status>
    <PostedBy>string</PostedBy>
    <UserID>int</UserID>
    <MailTo>string</MailTo>
    <Note>string</Note>
    <Attachment>
      <FileName>string</FileName>
      <Content>base64Binary</Content>
    </Attachment>
  </InterconnectNote>
</ArrayOfInterconnectNote>

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.