ECGridOS API v4
Click here for a complete list of operations.
CertAddPrivate
Add a new Private AS2 Certificate.
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/CertAddPrivate" <?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> <CertAddPrivate xmlns="https://os.ecgrid.io/"> <SessionID>string</SessionID> <CommID>int</CommID> <CertType>X509 or PGP or SSH</CertType> <KeyId>string</KeyId> <UserId>string</UserId> <BeginUsage>dateTime</BeginUsage> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <PartnerAS2ID>string</PartnerAS2ID> <Cert>base64Binary</Cert> <Password>string</Password> </CertAddPrivate> </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> <CertAddPrivateResponse xmlns="https://os.ecgrid.io/"> <CertAddPrivateResult> <CommID>int</CommID> <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> <CertificateInfo> <CertKeyID>int</CertKeyID> <PartnerAS2ID>string</PartnerAS2ID> <PartnerURL>string</PartnerURL> <Type>X509 or PGP or SSH</Type> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <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 xsi:nil="true" /> </CertificateInfo> <CertificateInfo> <CertKeyID>int</CertKeyID> <PartnerAS2ID>string</PartnerAS2ID> <PartnerURL>string</PartnerURL> <Type>X509 or PGP or SSH</Type> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <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 xsi:nil="true" /> </CertificateInfo> </Certificates> </CertAddPrivateResult> </CertAddPrivateResponse> </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> <CertAddPrivate xmlns="https://os.ecgrid.io/"> <SessionID>string</SessionID> <CommID>int</CommID> <CertType>X509 or PGP or SSH</CertType> <KeyId>string</KeyId> <UserId>string</UserId> <BeginUsage>dateTime</BeginUsage> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <PartnerAS2ID>string</PartnerAS2ID> <Cert>base64Binary</Cert> <Password>string</Password> </CertAddPrivate> </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> <CertAddPrivateResponse xmlns="https://os.ecgrid.io/"> <CertAddPrivateResult> <CommID>int</CommID> <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> <CertificateInfo> <CertKeyID>int</CertKeyID> <PartnerAS2ID>string</PartnerAS2ID> <PartnerURL>string</PartnerURL> <Type>X509 or PGP or SSH</Type> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <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 xsi:nil="true" /> </CertificateInfo> <CertificateInfo> <CertKeyID>int</CertKeyID> <PartnerAS2ID>string</PartnerAS2ID> <PartnerURL>string</PartnerURL> <Type>X509 or PGP or SSH</Type> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <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 xsi:nil="true" /> </CertificateInfo> </Certificates> </CertAddPrivateResult> </CertAddPrivateResponse> </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/CertAddPrivate?SessionID=string&CommID=string&CertType=string&KeyId=string&UserId=string&BeginUsage=string&Usage=string&PartnerAS2ID=string&Cert=string&Cert=string&Password=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"?> <as2CommInfo xmlns="https://os.ecgrid.io/"> <CommID>int</CommID> <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> <CertificateInfo> <CertKeyID>int</CertKeyID> <PartnerAS2ID>string</PartnerAS2ID> <PartnerURL>string</PartnerURL> <Type>X509 or PGP or SSH</Type> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <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> <Password>string</Password> <PrivatePFX>base64Binary</PrivatePFX> </RootInfo> </CertificateInfo> <CertificateInfo> <CertKeyID>int</CertKeyID> <PartnerAS2ID>string</PartnerAS2ID> <PartnerURL>string</PartnerURL> <Type>X509 or PGP or SSH</Type> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <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> <Password>string</Password> <PrivatePFX>base64Binary</PrivatePFX> </RootInfo> </CertificateInfo> </Certificates> </as2CommInfo>
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/CertAddPrivate HTTP/1.1 Host: os.ecgrid.io Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&CommID=string&CertType=string&KeyId=string&UserId=string&BeginUsage=string&Usage=string&PartnerAS2ID=string&Cert=string&Cert=string&Password=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <as2CommInfo xmlns="https://os.ecgrid.io/"> <CommID>int</CommID> <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> <CertificateInfo> <CertKeyID>int</CertKeyID> <PartnerAS2ID>string</PartnerAS2ID> <PartnerURL>string</PartnerURL> <Type>X509 or PGP or SSH</Type> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <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> <Password>string</Password> <PrivatePFX>base64Binary</PrivatePFX> </RootInfo> </CertificateInfo> <CertificateInfo> <CertKeyID>int</CertKeyID> <PartnerAS2ID>string</PartnerAS2ID> <PartnerURL>string</PartnerURL> <Type>X509 or PGP or SSH</Type> <Usage>SSL or Encryption or Signature or EncryptionAndSignature</Usage> <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> <Password>string</Password> <PrivatePFX>base64Binary</PrivatePFX> </RootInfo> </CertificateInfo> </Certificates> </as2CommInfo>