ECGridOS API v2 Web Service

ECGridOS API v2

Click here for a complete list of operations.

CarbonCopyInfo

Detail for a Carbon Copy.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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

<?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>
    <CarbonCopyInfo xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <CarbonCopyID>int</CarbonCopyID>
    </CarbonCopyInfo>
  </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>
    <CarbonCopyInfoResponse xmlns="http://ecgridos.net/">
      <CarbonCopyInfoResult>
        <CarbonCopyID>int</CarbonCopyID>
        <NetworkID>int</NetworkID>
        <MailboxID>int</MailboxID>
        <Created>dateTime</Created>
        <Modified>dateTime</Modified>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <OriginalFrom>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
          </OwnerInfo>
        </OriginalFrom>
        <OriginalTo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
          </OwnerInfo>
        </OriginalTo>
        <CCFrom>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
          </OwnerInfo>
        </CCFrom>
        <CCTo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
          </OwnerInfo>
        </CCTo>
        <TransactionSet>string</TransactionSet>
      </CarbonCopyInfoResult>
    </CarbonCopyInfoResponse>
  </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 /v2.3/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>
    <CarbonCopyInfo xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <CarbonCopyID>int</CarbonCopyID>
    </CarbonCopyInfo>
  </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>
    <CarbonCopyInfoResponse xmlns="http://ecgridos.net/">
      <CarbonCopyInfoResult>
        <CarbonCopyID>int</CarbonCopyID>
        <NetworkID>int</NetworkID>
        <MailboxID>int</MailboxID>
        <Created>dateTime</Created>
        <Modified>dateTime</Modified>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <OriginalFrom>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
          </OwnerInfo>
        </OriginalFrom>
        <OriginalTo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
          </OwnerInfo>
        </OriginalTo>
        <CCFrom>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
          </OwnerInfo>
        </CCFrom>
        <CCTo>
          <ECGridID>int</ECGridID>
          <NetworkID>int</NetworkID>
          <NetworkName>string</NetworkName>
          <Qualifier>string</Qualifier>
          <ID>string</ID>
          <Description>string</Description>
          <DataEMail>string</DataEMail>
          <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
          <OwnerInfo>
            <NetworkID>int</NetworkID>
            <NetworkName>string</NetworkName>
            <MailboxID>int</MailboxID>
            <MailboxName>string</MailboxName>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <Effective>dateTime</Effective>
            <Expires>dateTime</Expires>
            <LastTraffic>dateTime</LastTraffic>
          </OwnerInfo>
        </CCTo>
        <TransactionSet>string</TransactionSet>
      </CarbonCopyInfoResult>
    </CarbonCopyInfoResponse>
  </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 /v2.3/prod/ecgridos.asmx/CarbonCopyInfo?SessionID=string&CarbonCopyID=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"?>
<CarbonCopyIDInfo xmlns="http://ecgridos.net/">
  <CarbonCopyID>int</CarbonCopyID>
  <NetworkID>int</NetworkID>
  <MailboxID>int</MailboxID>
  <Created>dateTime</Created>
  <Modified>dateTime</Modified>
  <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
  <OriginalFrom>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
    </OwnerInfo>
  </OriginalFrom>
  <OriginalTo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
    </OwnerInfo>
  </OriginalTo>
  <CCFrom>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
    </OwnerInfo>
  </CCFrom>
  <CCTo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
    </OwnerInfo>
  </CCTo>
  <TransactionSet>string</TransactionSet>
</CarbonCopyIDInfo>

HTTP POST

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

POST /v2.3/prod/ecgridos.asmx/CarbonCopyInfo HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&CarbonCopyID=string

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

<?xml version="1.0" encoding="utf-8"?>
<CarbonCopyIDInfo xmlns="http://ecgridos.net/">
  <CarbonCopyID>int</CarbonCopyID>
  <NetworkID>int</NetworkID>
  <MailboxID>int</MailboxID>
  <Created>dateTime</Created>
  <Modified>dateTime</Modified>
  <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
  <OriginalFrom>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
    </OwnerInfo>
  </OriginalFrom>
  <OriginalTo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
    </OwnerInfo>
  </OriginalTo>
  <CCFrom>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
    </OwnerInfo>
  </CCFrom>
  <CCTo>
    <ECGridID>int</ECGridID>
    <NetworkID>int</NetworkID>
    <NetworkName>string</NetworkName>
    <Qualifier>string</Qualifier>
    <ID>string</ID>
    <Description>string</Description>
    <DataEMail>string</DataEMail>
    <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
    <OwnerInfo>
      <NetworkID>int</NetworkID>
      <NetworkName>string</NetworkName>
      <MailboxID>int</MailboxID>
      <MailboxName>string</MailboxName>
      <Created>dateTime</Created>
      <Modified>dateTime</Modified>
      <Effective>dateTime</Effective>
      <Expires>dateTime</Expires>
      <LastTraffic>dateTime</LastTraffic>
    </OwnerInfo>
  </CCTo>
  <TransactionSet>string</TransactionSet>
</CarbonCopyIDInfo>

Parameter	Value
SessionID:
CarbonCopyID: