ECGridOS API v4 Web Service

ECGridOS API v4

Click here for a complete list of operations.

InterconnectNote

Add a Note to an Interconnect Request.

Test

The test form is only available for methods with primitive types as parameters.

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/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="https://os.ecgrid.io/">
      <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="https://os.ecgrid.io/">
      <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 /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>
    <InterconnectNote xmlns="https://os.ecgrid.io/">
      <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="https://os.ecgrid.io/">
      <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 /v4.1/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: 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/InterconnectNote HTTP/1.1
Host: os.ecgrid.io
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="https://os.ecgrid.io/">boolean</boolean>