ECGridOS API v3


Click here for a complete list of operations.

TPListByOwner

List Trading Partners by Owner UserID.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
OwnerUserID:
OrderBy:
ShowInactive:
PageSize:
PageNumber:

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/TPListByOwner"

<?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>
    <TPListByOwner xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <OwnerUserID>int</OwnerUserID>
      <OrderBy>Description or QID</OrderBy>
      <ShowInactive>boolean</ShowInactive>
      <PageSize>short</PageSize>
      <PageNumber>short</PageNumber>
    </TPListByOwner>
  </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>
    <TPListByOwnerResponse xmlns="http://ecgridos.net/">
      <TPListByOwnerResult>
        <PageSize>short</PageSize>
        <PageNumber>short</PageNumber>
        <Count>long</Count>
        <TotalRecords>int</TotalRecords>
        <TotalPages>short</TotalPages>
        <ECGridIDInfoList>
          <ECGridIDInfo>
            <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>
            <Owner xsi:nil="true" />
            <OwnerInfo xsi:nil="true" />
          </ECGridIDInfo>
          <ECGridIDInfo>
            <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>
            <Owner xsi:nil="true" />
            <OwnerInfo xsi:nil="true" />
          </ECGridIDInfo>
        </ECGridIDInfoList>
      </TPListByOwnerResult>
    </TPListByOwnerResponse>
  </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>
    <TPListByOwner xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <OwnerUserID>int</OwnerUserID>
      <OrderBy>Description or QID</OrderBy>
      <ShowInactive>boolean</ShowInactive>
      <PageSize>short</PageSize>
      <PageNumber>short</PageNumber>
    </TPListByOwner>
  </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>
    <TPListByOwnerResponse xmlns="http://ecgridos.net/">
      <TPListByOwnerResult>
        <PageSize>short</PageSize>
        <PageNumber>short</PageNumber>
        <Count>long</Count>
        <TotalRecords>int</TotalRecords>
        <TotalPages>short</TotalPages>
        <ECGridIDInfoList>
          <ECGridIDInfo>
            <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>
            <Owner xsi:nil="true" />
            <OwnerInfo xsi:nil="true" />
          </ECGridIDInfo>
          <ECGridIDInfo>
            <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>
            <Owner xsi:nil="true" />
            <OwnerInfo xsi:nil="true" />
          </ECGridIDInfo>
        </ECGridIDInfoList>
      </TPListByOwnerResult>
    </TPListByOwnerResponse>
  </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/TPListByOwner?SessionID=string&OwnerUserID=string&OrderBy=string&ShowInactive=string&PageSize=string&PageNumber=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"?>
<ECGridIDInfoCollection xmlns="http://ecgridos.net/">
  <PageSize>short</PageSize>
  <PageNumber>short</PageNumber>
  <Count>long</Count>
  <TotalRecords>int</TotalRecords>
  <TotalPages>short</TotalPages>
  <ECGridIDInfoList>
    <ECGridIDInfo>
      <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>
      <Owner>
        <UserID>int</UserID>
        <LoginName>string</LoginName>
        <RecoveryQuestion>string</RecoveryQuestion>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Company>string</Company>
        <EMail>string</EMail>
        <Phone>string</Phone>
        <CellPhone>string</CellPhone>
        <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
        <TimeZoneOffset>short</TimeZoneOffset>
        <NetworkID>int</NetworkID>
        <MailboxID>int</MailboxID>
        <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
        <Created>dateTime</Created>
        <Modified>dateTime</Modified>
        <LastLogin>dateTime</LastLogin>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <LockedOut>boolean</LockedOut>
        <OpenSessions>short</OpenSessions>
      </Owner>
      <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 ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
      </OwnerInfo>
    </ECGridIDInfo>
    <ECGridIDInfo>
      <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>
      <Owner>
        <UserID>int</UserID>
        <LoginName>string</LoginName>
        <RecoveryQuestion>string</RecoveryQuestion>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Company>string</Company>
        <EMail>string</EMail>
        <Phone>string</Phone>
        <CellPhone>string</CellPhone>
        <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
        <TimeZoneOffset>short</TimeZoneOffset>
        <NetworkID>int</NetworkID>
        <MailboxID>int</MailboxID>
        <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
        <Created>dateTime</Created>
        <Modified>dateTime</Modified>
        <LastLogin>dateTime</LastLogin>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <LockedOut>boolean</LockedOut>
        <OpenSessions>short</OpenSessions>
      </Owner>
      <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 ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
      </OwnerInfo>
    </ECGridIDInfo>
  </ECGridIDInfoList>
</ECGridIDInfoCollection>

HTTP POST

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

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

SessionID=string&OwnerUserID=string&OrderBy=string&ShowInactive=string&PageSize=string&PageNumber=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ECGridIDInfoCollection xmlns="http://ecgridos.net/">
  <PageSize>short</PageSize>
  <PageNumber>short</PageNumber>
  <Count>long</Count>
  <TotalRecords>int</TotalRecords>
  <TotalPages>short</TotalPages>
  <ECGridIDInfoList>
    <ECGridIDInfo>
      <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>
      <Owner>
        <UserID>int</UserID>
        <LoginName>string</LoginName>
        <RecoveryQuestion>string</RecoveryQuestion>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Company>string</Company>
        <EMail>string</EMail>
        <Phone>string</Phone>
        <CellPhone>string</CellPhone>
        <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
        <TimeZoneOffset>short</TimeZoneOffset>
        <NetworkID>int</NetworkID>
        <MailboxID>int</MailboxID>
        <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
        <Created>dateTime</Created>
        <Modified>dateTime</Modified>
        <LastLogin>dateTime</LastLogin>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <LockedOut>boolean</LockedOut>
        <OpenSessions>short</OpenSessions>
      </Owner>
      <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 ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
      </OwnerInfo>
    </ECGridIDInfo>
    <ECGridIDInfo>
      <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>
      <Owner>
        <UserID>int</UserID>
        <LoginName>string</LoginName>
        <RecoveryQuestion>string</RecoveryQuestion>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Company>string</Company>
        <EMail>string</EMail>
        <Phone>string</Phone>
        <CellPhone>string</CellPhone>
        <CellCarrier>NoChange or Undefined or ATTCingular or Verizon or TMobile or SprintPCS or Nextel or Alltel or VirginMobile or ATTPreCingular or ATT or BoostMobile or USCellular or MetroPCS or Powertel</CellCarrier>
        <TimeZoneOffset>short</TimeZoneOffset>
        <NetworkID>int</NetworkID>
        <MailboxID>int</MailboxID>
        <AuthLevel>NoChange or Root or TechOps or NetOps or NetworkAdmin or NetworkUser or MailboxAdmin or MailboxUser or TPUser or General</AuthLevel>
        <Created>dateTime</Created>
        <Modified>dateTime</Modified>
        <LastLogin>dateTime</LastLogin>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <LockedOut>boolean</LockedOut>
        <OpenSessions>short</OpenSessions>
      </Owner>
      <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 ManagedFileTransfer or SuperHub or Test or Suspense1 or Suspense2 or Suspense3</RoutingGroup>
      </OwnerInfo>
    </ECGridIDInfo>
  </ECGridIDInfoList>
</ECGridIDInfoCollection>