ECGridOS API v3


Click here for a complete list of operations.

TPGetMailboxDefault

Sets an ECGridID as the default in its mailbox.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
NetworkID:
MailboxID:

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

<?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>
    <TPGetMailboxDefault xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
    </TPGetMailboxDefault>
  </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>
    <TPGetMailboxDefaultResponse xmlns="http://ecgridos.net/">
      <TPGetMailboxDefaultResult>
        <ECGridID>int</ECGridID>
        <NetworkID>int</NetworkID>
        <NetworkName>string</NetworkName>
        <MailboxID>int</MailboxID>
        <MailboxName>string</MailboxName>
        <Qualifier>string</Qualifier>
        <ID>string</ID>
        <Description>string</Description>
        <DataEMail>string</DataEMail>
        <MailboxDefault>boolean</MailboxDefault>
        <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
        <UseType>Undefined or Test or Production or TestAndProduction</UseType>
        <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>
          <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
        </OwnerInfo>
      </TPGetMailboxDefaultResult>
    </TPGetMailboxDefaultResponse>
  </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.0/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>
    <TPGetMailboxDefault xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
    </TPGetMailboxDefault>
  </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>
    <TPGetMailboxDefaultResponse xmlns="http://ecgridos.net/">
      <TPGetMailboxDefaultResult>
        <ECGridID>int</ECGridID>
        <NetworkID>int</NetworkID>
        <NetworkName>string</NetworkName>
        <MailboxID>int</MailboxID>
        <MailboxName>string</MailboxName>
        <Qualifier>string</Qualifier>
        <ID>string</ID>
        <Description>string</Description>
        <DataEMail>string</DataEMail>
        <MailboxDefault>boolean</MailboxDefault>
        <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
        <UseType>Undefined or Test or Production or TestAndProduction</UseType>
        <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>
          <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
        </OwnerInfo>
      </TPGetMailboxDefaultResult>
    </TPGetMailboxDefaultResponse>
  </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.0/prod/ecgridos.asmx/TPGetMailboxDefault?SessionID=string&NetworkID=string&MailboxID=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"?>
<ECGridIDInfo xmlns="http://ecgridos.net/">
  <ECGridID>int</ECGridID>
  <NetworkID>int</NetworkID>
  <NetworkName>string</NetworkName>
  <MailboxID>int</MailboxID>
  <MailboxName>string</MailboxName>
  <Qualifier>string</Qualifier>
  <ID>string</ID>
  <Description>string</Description>
  <DataEMail>string</DataEMail>
  <MailboxDefault>boolean</MailboxDefault>
  <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
  <UseType>Undefined or Test or Production or TestAndProduction</UseType>
  <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>
    <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
  </OwnerInfo>
</ECGridIDInfo>

HTTP POST

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

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

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

<?xml version="1.0" encoding="utf-8"?>
<ECGridIDInfo xmlns="http://ecgridos.net/">
  <ECGridID>int</ECGridID>
  <NetworkID>int</NetworkID>
  <NetworkName>string</NetworkName>
  <MailboxID>int</MailboxID>
  <MailboxName>string</MailboxName>
  <Qualifier>string</Qualifier>
  <ID>string</ID>
  <Description>string</Description>
  <DataEMail>string</DataEMail>
  <MailboxDefault>boolean</MailboxDefault>
  <Status>Active or AutoRoute or Pending or Suspended or Terminated or Duplicate</Status>
  <UseType>Undefined or Test or Production or TestAndProduction</UseType>
  <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>
    <RoutingGroup>ProductionA or ProductionB or Migration1 or Migration2 or NetOpsOnly1 or NetOpsOnly2 or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
  </OwnerInfo>
</ECGridIDInfo>