Skip to content

InterconnectCancel

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

Back To Common API Calls


Cancel an Interconnect Request.

  public boolean InterconnectCancel(string SessionID,
                                    int InterconnectID,
                                    string Note,
                                    eMailTo EMailTo,
                                    string OtherEMailAddress)

Parameters


Returns

boolean


Remarks

This allows a Pending Interconnect Request to be canceled. An optional Note can be included with the cancellation.

It does not prevent data from flowing between Trading Partners if an Interconnect is already in place. For this, you will need to contact the Trading Partner directly.

The EMailTo parameter allows a copy of the Cancellation 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()](https://github.com/LorenData/ECGridOS_API/wiki/InterconnectAdd))
The Mailbox InterconnectsContact. [pending implementation]
The Network InterconnectContact/InterconnectEMail.

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

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


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 = 976;
            string Note = "No Longer need this connection.";
            string OtherEMailAddress = "JohnDoe@abc.com";

            bool CancelResults = ECGrid.InterconnectCancel(SessionID, InterconnectID, Note, ECGridService.eMailTo.NoEMail, 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 /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/InterconnectCancel"

<?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>
    <InterconnectCancel xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <InterconnectID>int</InterconnectID>
      <Note>string</Note>
      <EMailTo>NoEMail or Requestor or Network or RequestorAndNetwork or Other or RequestorAndOther or NetworkAndOther or EMailAll</EMailTo>
      <OtherEMailAddress>string</OtherEMailAddress>
    </InterconnectCancel>
  </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>
    <InterconnectCancelResponse xmlns="https://os.ecgrid.io/">
      <InterconnectCancelResult>boolean</InterconnectCancelResult>
    </InterconnectCancelResponse>
  </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>
    <InterconnectCancel xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <InterconnectID>int</InterconnectID>
      <Note>string</Note>
      <EMailTo>NoEMail or Requestor or Network or RequestorAndNetwork or Other or RequestorAndOther or NetworkAndOther or EMailAll</EMailTo>
      <OtherEMailAddress>string</OtherEMailAddress>
    </InterconnectCancel>
  </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>
    <InterconnectCancelResponse xmlns="https://os.ecgrid.io/">
      <InterconnectCancelResult>boolean</InterconnectCancelResult>
    </InterconnectCancelResponse>
  </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/InterconnectCancel?SessionID=string&InterconnectID=string&Note=string&EMailTo=string&OtherEMailAddress=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"?>
<boolean xmlns="https://os.ecgrid.io/">boolean</boolean>

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

SessionID=string&InterconnectID=string&Note=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="https://os.ecgrid.io/">boolean</boolean>

Back To Common API Calls

Clone this wiki locally