InterconnectNote

Greg Kolinski edited this page Sep 26, 2017 · 2 revisions

Back To Common API Calls


Add a Note to an Interconnect Request.

  public bool InterconnectNote(string SessionID, 
                               int InterconnectID, 
                               AuthLevel AuthLevel, 
                               string Note, 
                               string AttachmentName, 
                               [XmlElementAttribute(DataType="base64Binary")] byte[] AttachmentContent, 
                               eMailTo EMailTo, 
                               string OtherEMailAddress)

Parameters:


Returns

True if successful, false on failure. - Boolean


Remarks

Ad hoc notes can be added to an Interconnect Request.

The EMailTo parameter allows a note to be e-mailed in addition to being stored in the system. Each Interconnect has several default e-mail addresses attached to it:

The Requestor (see ContactName & ContactEMail in InterconnectAdd())
The Mailbox InterconnectsContact.
The Network InterconnectContact/InterconnectEMail.

ECGrid NetOps is CCed with all Interconnect Notes that are e-mailed.

OtherEMailAddress allows any additional party to be e-mailed with this note.


Code Example

C#

using System.Xml;
using System.IO;
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;
            string Note = "This is a Note";
            string AttachmentName = "InterconnectInfoAttachemnt.txt";

            byte[] ContentFromFile = File.ReadAllBytes(@"C:\Temp\MyFile.pdf");

            /* .Net will Auto Convert byte[] to Base64 on Transport. 
            Below is the explicit Conversion for your reference

              string Base64HeaderString = Convert.ToBase64String(ContentFromFile);
              byte[] AttachmentContentBase64EncodedBytes = Convert.FromBase64String(Base64HeaderString);
            */
            string OtherEMailAddress = "Person@domain.com";

            bool InterconnectNoteAdded = ECGrid.InterconnectNote(SessionID, InterconnectID, ECGridService.AuthLevel.MailboxAdmin, Note, AttachmentName, ContentFromFile, ECGridService.eMailTo.Network,OtherEMailAddress);

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

<?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>
    <InterconnectNote xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <InterconnectID>int</InterconnectID>
      <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
      <Note>string</Note>
      <AttachmentName>string</AttachmentName>
      <AttachmentContent>base64Binary</AttachmentContent>
      <EMailTo>NoEMail or Requestor or Network or RequestorAndNetwork or Other or RequestorAndOther or NetworkAndOther or EMailAll</EMailTo>
      <OtherEMailAddress>string</OtherEMailAddress>
    </InterconnectNote>
  </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>
    <InterconnectNoteResponse xmlns="http://ecgridos.net/">
      <InterconnectNoteResult>boolean</InterconnectNoteResult>
    </InterconnectNoteResponse>
  </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>
    <InterconnectNote xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <InterconnectID>int</InterconnectID>
      <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
      <Note>string</Note>
      <AttachmentName>string</AttachmentName>
      <AttachmentContent>base64Binary</AttachmentContent>
      <EMailTo>NoEMail or Requestor or Network or RequestorAndNetwork or Other or RequestorAndOther or NetworkAndOther or EMailAll</EMailTo>
      <OtherEMailAddress>string</OtherEMailAddress>
    </InterconnectNote>
  </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>
    <InterconnectNoteResponse xmlns="http://ecgridos.net/">
      <InterconnectNoteResult>boolean</InterconnectNoteResult>
    </InterconnectNoteResponse>
  </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/InterconnectNote?SessionID=string&InterconnectID=string&AuthLevel=string&Note=string&AttachmentName=string&AttachmentContent=string&AttachmentContent=string&EMailTo=string&OtherEMailAddress=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"?>
<boolean xmlns="http://ecgridos.net/">boolean</boolean>

HTTP POST

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

SessionID=string&InterconnectID=string&AuthLevel=string&Note=string&AttachmentName=string&AttachmentContent=string&AttachmentContent=string&EMailTo=string&OtherEMailAddress=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://ecgridos.net/">boolean</boolean>

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.