Skip to content

CommFind

Jump to bottom
Lee Bolgatz edited this page Oct 28, 2022 · 1 revision

Back To Common API Calls

Find Communication Profiles by Identifier.

  public CommIDInfo[] CommFind(string SessionID,
                               string Identifier,
                               NetworkGatewayCommChannel CommType,
                               boolean PrivateKeyRequired,
                               UseType UseType,
                               boolean ShowInactive)

Parameters

Returns

CommIDInfo[]

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

<?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>
    <CommFind xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <Identifier>string</Identifier>
      <CommType>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</CommType>
      <PrivateKeyRequired>boolean</PrivateKeyRequired>
      <UseType>Undefined or Test or Production or TestAndProduction</UseType>
      <ShowInactive>boolean</ShowInactive>
    </CommFind>
  </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>
    <CommFindResponse xmlns="https://os.ecgrid.io/">
      <CommFindResult>
        <CommIDInfo>
          <CommID>int</CommID>
          <Type>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</Type>
          <Version>string</Version>
          <Created>dateTime</Created>
          <Modified>dateTime</Modified>
          <Hosted>boolean</Hosted>
          <Identifier>string</Identifier>
          <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>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <UseType>Undefined or Test or Production or TestAndProduction</UseType>
          <URL>string</URL>
          <MimeTypeOverride>string</MimeTypeOverride>
          <SignData>boolean</SignData>
          <EncryptData>boolean</EncryptData>
          <CompressData>boolean</CompressData>
          <BeginUsage>dateTime</BeginUsage>
          <EndUsage>dateTime</EndUsage>
          <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
          <Receipt>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</Receipt>
          <SSLClientAuthentication>boolean</SSLClientAuthentication>
          <HTTPAuthentication>
            <Type>None or Basic or Digest or Certificate</Type>
            <User>string</User>
            <Password>string</Password>
          </HTTPAuthentication>
          <Certificates>
            <Certificate xsi:nil="true" />
            <Certificate xsi:nil="true" />
          </Certificates>
        </CommIDInfo>
        <CommIDInfo>
          <CommID>int</CommID>
          <Type>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</Type>
          <Version>string</Version>
          <Created>dateTime</Created>
          <Modified>dateTime</Modified>
          <Hosted>boolean</Hosted>
          <Identifier>string</Identifier>
          <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>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <UseType>Undefined or Test or Production or TestAndProduction</UseType>
          <URL>string</URL>
          <MimeTypeOverride>string</MimeTypeOverride>
          <SignData>boolean</SignData>
          <EncryptData>boolean</EncryptData>
          <CompressData>boolean</CompressData>
          <BeginUsage>dateTime</BeginUsage>
          <EndUsage>dateTime</EndUsage>
          <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
          <Receipt>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</Receipt>
          <SSLClientAuthentication>boolean</SSLClientAuthentication>
          <HTTPAuthentication>
            <Type>None or Basic or Digest or Certificate</Type>
            <User>string</User>
            <Password>string</Password>
          </HTTPAuthentication>
          <Certificates>
            <Certificate xsi:nil="true" />
            <Certificate xsi:nil="true" />
          </Certificates>
        </CommIDInfo>
      </CommFindResult>
    </CommFindResponse>
  </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>
    <CommFind xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <Identifier>string</Identifier>
      <CommType>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</CommType>
      <PrivateKeyRequired>boolean</PrivateKeyRequired>
      <UseType>Undefined or Test or Production or TestAndProduction</UseType>
      <ShowInactive>boolean</ShowInactive>
    </CommFind>
  </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>
    <CommFindResponse xmlns="https://os.ecgrid.io/">
      <CommFindResult>
        <CommIDInfo>
          <CommID>int</CommID>
          <Type>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</Type>
          <Version>string</Version>
          <Created>dateTime</Created>
          <Modified>dateTime</Modified>
          <Hosted>boolean</Hosted>
          <Identifier>string</Identifier>
          <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>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <UseType>Undefined or Test or Production or TestAndProduction</UseType>
          <URL>string</URL>
          <MimeTypeOverride>string</MimeTypeOverride>
          <SignData>boolean</SignData>
          <EncryptData>boolean</EncryptData>
          <CompressData>boolean</CompressData>
          <BeginUsage>dateTime</BeginUsage>
          <EndUsage>dateTime</EndUsage>
          <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
          <Receipt>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</Receipt>
          <SSLClientAuthentication>boolean</SSLClientAuthentication>
          <HTTPAuthentication>
            <Type>None or Basic or Digest or Certificate</Type>
            <User>string</User>
            <Password>string</Password>
          </HTTPAuthentication>
          <Certificates>
            <Certificate xsi:nil="true" />
            <Certificate xsi:nil="true" />
          </Certificates>
        </CommIDInfo>
        <CommIDInfo>
          <CommID>int</CommID>
          <Type>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</Type>
          <Version>string</Version>
          <Created>dateTime</Created>
          <Modified>dateTime</Modified>
          <Hosted>boolean</Hosted>
          <Identifier>string</Identifier>
          <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>
          <NetworkID>int</NetworkID>
          <MailboxID>int</MailboxID>
          <UseType>Undefined or Test or Production or TestAndProduction</UseType>
          <URL>string</URL>
          <MimeTypeOverride>string</MimeTypeOverride>
          <SignData>boolean</SignData>
          <EncryptData>boolean</EncryptData>
          <CompressData>boolean</CompressData>
          <BeginUsage>dateTime</BeginUsage>
          <EndUsage>dateTime</EndUsage>
          <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
          <Receipt>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</Receipt>
          <SSLClientAuthentication>boolean</SSLClientAuthentication>
          <HTTPAuthentication>
            <Type>None or Basic or Digest or Certificate</Type>
            <User>string</User>
            <Password>string</Password>
          </HTTPAuthentication>
          <Certificates>
            <Certificate xsi:nil="true" />
            <Certificate xsi:nil="true" />
          </Certificates>
        </CommIDInfo>
      </CommFindResult>
    </CommFindResponse>
  </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/CommFind?SessionID=string&Identifier=string&CommType=string&PrivateKeyRequired=string&UseType=string&ShowInactive=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"?>
<ArrayOfCommIDInfo xmlns="https://os.ecgrid.io/">
  <CommIDInfo>
    <CommID>int</CommID>
    <Type>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</Type>
    <Version>string</Version>
    <Created>dateTime</Created>
    <Modified>dateTime</Modified>
    <Hosted>boolean</Hosted>
    <Identifier>string</Identifier>
    <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>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <UseType>Undefined or Test or Production or TestAndProduction</UseType>
    <URL>string</URL>
    <MimeTypeOverride>string</MimeTypeOverride>
    <SignData>boolean</SignData>
    <EncryptData>boolean</EncryptData>
    <CompressData>boolean</CompressData>
    <BeginUsage>dateTime</BeginUsage>
    <EndUsage>dateTime</EndUsage>
    <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    <Receipt>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</Receipt>
    <SSLClientAuthentication>boolean</SSLClientAuthentication>
    <HTTPAuthentication>
      <Type>None or Basic or Digest or Certificate</Type>
      <User>string</User>
      <Password>string</Password>
    </HTTPAuthentication>
    <Certificates>
      <Certificate>
        <CertKeyID>int</CertKeyID>
        <PartnerID>string</PartnerID>
        <PartnerURL>string</PartnerURL>
        <Type>X509 or PGP or SSH</Type>
        <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage>
        <KeyID>string</KeyID>
        <UserID>string</UserID>
        <SecureHashAlgorithm>string</SecureHashAlgorithm>
        <Subject>string</Subject>
        <Issuer>string</Issuer>
        <HasPrivateKey>boolean</HasPrivateKey>
        <PublicCertificate>base64Binary</PublicCertificate>
        <BeginUsage>dateTime</BeginUsage>
        <EndUsage>dateTime</EndUsage>
        <NotBefore>dateTime</NotBefore>
        <NotAfter>dateTime</NotAfter>
        <SerialNumber>string</SerialNumber>
        <Thumbprint>string</Thumbprint>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <RootInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CertType>cstUser or cstMachine or cstPFXFile or cstPFXBlob or cstJKSFile or cstJKSBlob or cstPEMKeyFile or cstPEMKeyBlob or cstPublicKeyFile or cstPublicKeyBlob or cstSSHPublicKeyBlob or cstP7BFile or cstP7BBlob or cstSSHPublicKeyFile or cstPPKFile or cstPPKBlob or cstXMLFile or cstXMLBlob or cstJWKFile or cstJWKBlob</CertType>
      </Certificate>
      <Certificate>
        <CertKeyID>int</CertKeyID>
        <PartnerID>string</PartnerID>
        <PartnerURL>string</PartnerURL>
        <Type>X509 or PGP or SSH</Type>
        <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage>
        <KeyID>string</KeyID>
        <UserID>string</UserID>
        <SecureHashAlgorithm>string</SecureHashAlgorithm>
        <Subject>string</Subject>
        <Issuer>string</Issuer>
        <HasPrivateKey>boolean</HasPrivateKey>
        <PublicCertificate>base64Binary</PublicCertificate>
        <BeginUsage>dateTime</BeginUsage>
        <EndUsage>dateTime</EndUsage>
        <NotBefore>dateTime</NotBefore>
        <NotAfter>dateTime</NotAfter>
        <SerialNumber>string</SerialNumber>
        <Thumbprint>string</Thumbprint>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <RootInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CertType>cstUser or cstMachine or cstPFXFile or cstPFXBlob or cstJKSFile or cstJKSBlob or cstPEMKeyFile or cstPEMKeyBlob or cstPublicKeyFile or cstPublicKeyBlob or cstSSHPublicKeyBlob or cstP7BFile or cstP7BBlob or cstSSHPublicKeyFile or cstPPKFile or cstPPKBlob or cstXMLFile or cstXMLBlob or cstJWKFile or cstJWKBlob</CertType>
      </Certificate>
    </Certificates>
  </CommIDInfo>
  <CommIDInfo>
    <CommID>int</CommID>
    <Type>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</Type>
    <Version>string</Version>
    <Created>dateTime</Created>
    <Modified>dateTime</Modified>
    <Hosted>boolean</Hosted>
    <Identifier>string</Identifier>
    <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>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <UseType>Undefined or Test or Production or TestAndProduction</UseType>
    <URL>string</URL>
    <MimeTypeOverride>string</MimeTypeOverride>
    <SignData>boolean</SignData>
    <EncryptData>boolean</EncryptData>
    <CompressData>boolean</CompressData>
    <BeginUsage>dateTime</BeginUsage>
    <EndUsage>dateTime</EndUsage>
    <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    <Receipt>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</Receipt>
    <SSLClientAuthentication>boolean</SSLClientAuthentication>
    <HTTPAuthentication>
      <Type>None or Basic or Digest or Certificate</Type>
      <User>string</User>
      <Password>string</Password>
    </HTTPAuthentication>
    <Certificates>
      <Certificate>
        <CertKeyID>int</CertKeyID>
        <PartnerID>string</PartnerID>
        <PartnerURL>string</PartnerURL>
        <Type>X509 or PGP or SSH</Type>
        <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage>
        <KeyID>string</KeyID>
        <UserID>string</UserID>
        <SecureHashAlgorithm>string</SecureHashAlgorithm>
        <Subject>string</Subject>
        <Issuer>string</Issuer>
        <HasPrivateKey>boolean</HasPrivateKey>
        <PublicCertificate>base64Binary</PublicCertificate>
        <BeginUsage>dateTime</BeginUsage>
        <EndUsage>dateTime</EndUsage>
        <NotBefore>dateTime</NotBefore>
        <NotAfter>dateTime</NotAfter>
        <SerialNumber>string</SerialNumber>
        <Thumbprint>string</Thumbprint>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <RootInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CertType>cstUser or cstMachine or cstPFXFile or cstPFXBlob or cstJKSFile or cstJKSBlob or cstPEMKeyFile or cstPEMKeyBlob or cstPublicKeyFile or cstPublicKeyBlob or cstSSHPublicKeyBlob or cstP7BFile or cstP7BBlob or cstSSHPublicKeyFile or cstPPKFile or cstPPKBlob or cstXMLFile or cstXMLBlob or cstJWKFile or cstJWKBlob</CertType>
      </Certificate>
      <Certificate>
        <CertKeyID>int</CertKeyID>
        <PartnerID>string</PartnerID>
        <PartnerURL>string</PartnerURL>
        <Type>X509 or PGP or SSH</Type>
        <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage>
        <KeyID>string</KeyID>
        <UserID>string</UserID>
        <SecureHashAlgorithm>string</SecureHashAlgorithm>
        <Subject>string</Subject>
        <Issuer>string</Issuer>
        <HasPrivateKey>boolean</HasPrivateKey>
        <PublicCertificate>base64Binary</PublicCertificate>
        <BeginUsage>dateTime</BeginUsage>
        <EndUsage>dateTime</EndUsage>
        <NotBefore>dateTime</NotBefore>
        <NotAfter>dateTime</NotAfter>
        <SerialNumber>string</SerialNumber>
        <Thumbprint>string</Thumbprint>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <RootInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CertType>cstUser or cstMachine or cstPFXFile or cstPFXBlob or cstJKSFile or cstJKSBlob or cstPEMKeyFile or cstPEMKeyBlob or cstPublicKeyFile or cstPublicKeyBlob or cstSSHPublicKeyBlob or cstP7BFile or cstP7BBlob or cstSSHPublicKeyFile or cstPPKFile or cstPPKBlob or cstXMLFile or cstXMLBlob or cstJWKFile or cstJWKBlob</CertType>
      </Certificate>
    </Certificates>
  </CommIDInfo>
</ArrayOfCommIDInfo>

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

SessionID=string&Identifier=string&CommType=string&PrivateKeyRequired=string&UseType=string&ShowInactive=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCommIDInfo xmlns="https://os.ecgrid.io/">
  <CommIDInfo>
    <CommID>int</CommID>
    <Type>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</Type>
    <Version>string</Version>
    <Created>dateTime</Created>
    <Modified>dateTime</Modified>
    <Hosted>boolean</Hosted>
    <Identifier>string</Identifier>
    <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>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <UseType>Undefined or Test or Production or TestAndProduction</UseType>
    <URL>string</URL>
    <MimeTypeOverride>string</MimeTypeOverride>
    <SignData>boolean</SignData>
    <EncryptData>boolean</EncryptData>
    <CompressData>boolean</CompressData>
    <BeginUsage>dateTime</BeginUsage>
    <EndUsage>dateTime</EndUsage>
    <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    <Receipt>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</Receipt>
    <SSLClientAuthentication>boolean</SSLClientAuthentication>
    <HTTPAuthentication>
      <Type>None or Basic or Digest or Certificate</Type>
      <User>string</User>
      <Password>string</Password>
    </HTTPAuthentication>
    <Certificates>
      <Certificate>
        <CertKeyID>int</CertKeyID>
        <PartnerID>string</PartnerID>
        <PartnerURL>string</PartnerURL>
        <Type>X509 or PGP or SSH</Type>
        <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage>
        <KeyID>string</KeyID>
        <UserID>string</UserID>
        <SecureHashAlgorithm>string</SecureHashAlgorithm>
        <Subject>string</Subject>
        <Issuer>string</Issuer>
        <HasPrivateKey>boolean</HasPrivateKey>
        <PublicCertificate>base64Binary</PublicCertificate>
        <BeginUsage>dateTime</BeginUsage>
        <EndUsage>dateTime</EndUsage>
        <NotBefore>dateTime</NotBefore>
        <NotAfter>dateTime</NotAfter>
        <SerialNumber>string</SerialNumber>
        <Thumbprint>string</Thumbprint>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <RootInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CertType>cstUser or cstMachine or cstPFXFile or cstPFXBlob or cstJKSFile or cstJKSBlob or cstPEMKeyFile or cstPEMKeyBlob or cstPublicKeyFile or cstPublicKeyBlob or cstSSHPublicKeyBlob or cstP7BFile or cstP7BBlob or cstSSHPublicKeyFile or cstPPKFile or cstPPKBlob or cstXMLFile or cstXMLBlob or cstJWKFile or cstJWKBlob</CertType>
      </Certificate>
      <Certificate>
        <CertKeyID>int</CertKeyID>
        <PartnerID>string</PartnerID>
        <PartnerURL>string</PartnerURL>
        <Type>X509 or PGP or SSH</Type>
        <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage>
        <KeyID>string</KeyID>
        <UserID>string</UserID>
        <SecureHashAlgorithm>string</SecureHashAlgorithm>
        <Subject>string</Subject>
        <Issuer>string</Issuer>
        <HasPrivateKey>boolean</HasPrivateKey>
        <PublicCertificate>base64Binary</PublicCertificate>
        <BeginUsage>dateTime</BeginUsage>
        <EndUsage>dateTime</EndUsage>
        <NotBefore>dateTime</NotBefore>
        <NotAfter>dateTime</NotAfter>
        <SerialNumber>string</SerialNumber>
        <Thumbprint>string</Thumbprint>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <RootInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CertType>cstUser or cstMachine or cstPFXFile or cstPFXBlob or cstJKSFile or cstJKSBlob or cstPEMKeyFile or cstPEMKeyBlob or cstPublicKeyFile or cstPublicKeyBlob or cstSSHPublicKeyBlob or cstP7BFile or cstP7BBlob or cstSSHPublicKeyFile or cstPPKFile or cstPPKBlob or cstXMLFile or cstXMLBlob or cstJWKFile or cstJWKBlob</CertType>
      </Certificate>
    </Certificates>
  </CommIDInfo>
  <CommIDInfo>
    <CommID>int</CommID>
    <Type>none or ftp or sftp or as2 or http or oftp or x400 or gisb or rnif or cxml or undefined</Type>
    <Version>string</Version>
    <Created>dateTime</Created>
    <Modified>dateTime</Modified>
    <Hosted>boolean</Hosted>
    <Identifier>string</Identifier>
    <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>
    <NetworkID>int</NetworkID>
    <MailboxID>int</MailboxID>
    <UseType>Undefined or Test or Production or TestAndProduction</UseType>
    <URL>string</URL>
    <MimeTypeOverride>string</MimeTypeOverride>
    <SignData>boolean</SignData>
    <EncryptData>boolean</EncryptData>
    <CompressData>boolean</CompressData>
    <BeginUsage>dateTime</BeginUsage>
    <EndUsage>dateTime</EndUsage>
    <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
    <Receipt>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</Receipt>
    <SSLClientAuthentication>boolean</SSLClientAuthentication>
    <HTTPAuthentication>
      <Type>None or Basic or Digest or Certificate</Type>
      <User>string</User>
      <Password>string</Password>
    </HTTPAuthentication>
    <Certificates>
      <Certificate>
        <CertKeyID>int</CertKeyID>
        <PartnerID>string</PartnerID>
        <PartnerURL>string</PartnerURL>
        <Type>X509 or PGP or SSH</Type>
        <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage>
        <KeyID>string</KeyID>
        <UserID>string</UserID>
        <SecureHashAlgorithm>string</SecureHashAlgorithm>
        <Subject>string</Subject>
        <Issuer>string</Issuer>
        <HasPrivateKey>boolean</HasPrivateKey>
        <PublicCertificate>base64Binary</PublicCertificate>
        <BeginUsage>dateTime</BeginUsage>
        <EndUsage>dateTime</EndUsage>
        <NotBefore>dateTime</NotBefore>
        <NotAfter>dateTime</NotAfter>
        <SerialNumber>string</SerialNumber>
        <Thumbprint>string</Thumbprint>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <RootInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CertType>cstUser or cstMachine or cstPFXFile or cstPFXBlob or cstJKSFile or cstJKSBlob or cstPEMKeyFile or cstPEMKeyBlob or cstPublicKeyFile or cstPublicKeyBlob or cstSSHPublicKeyBlob or cstP7BFile or cstP7BBlob or cstSSHPublicKeyFile or cstPPKFile or cstPPKBlob or cstXMLFile or cstXMLBlob or cstJWKFile or cstJWKBlob</CertType>
      </Certificate>
      <Certificate>
        <CertKeyID>int</CertKeyID>
        <PartnerID>string</PartnerID>
        <PartnerURL>string</PartnerURL>
        <Type>X509 or PGP or SSH</Type>
        <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage>
        <KeyID>string</KeyID>
        <UserID>string</UserID>
        <SecureHashAlgorithm>string</SecureHashAlgorithm>
        <Subject>string</Subject>
        <Issuer>string</Issuer>
        <HasPrivateKey>boolean</HasPrivateKey>
        <PublicCertificate>base64Binary</PublicCertificate>
        <BeginUsage>dateTime</BeginUsage>
        <EndUsage>dateTime</EndUsage>
        <NotBefore>dateTime</NotBefore>
        <NotAfter>dateTime</NotAfter>
        <SerialNumber>string</SerialNumber>
        <Thumbprint>string</Thumbprint>
        <Status>Development or Active or Preproduction or Suspended or Terminated</Status>
        <RootInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CertType>cstUser or cstMachine or cstPFXFile or cstPFXBlob or cstJKSFile or cstJKSBlob or cstPEMKeyFile or cstPEMKeyBlob or cstPublicKeyFile or cstPublicKeyBlob or cstSSHPublicKeyBlob or cstP7BFile or cstP7BBlob or cstSSHPublicKeyFile or cstPPKFile or cstPPKBlob or cstXMLFile or cstXMLBlob or cstJWKFile or cstJWKBlob</CertType>
      </Certificate>
    </Certificates>
  </CommIDInfo>
</ArrayOfCommIDInfo>

Back To Common API Calls

Home

Getting Started

Updates

ECGridOS Wiki

ECGridOS API Calls

Appendix

Legacy Forum Q & A

Clone this wiki locally