API Module SSL searchOrderSslCertRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 16: Line 16:
*offset ''default value: 0''
*offset ''default value: 0''
*commonNamePattern
*commonNamePattern
-
*status (PAI - Order was purchased but not been requested yet, REQ - order has been requested, it can be under internal pre-validation or sent to CA, ACT - order is active, REJ- cancel was requested for the order, but has not been finished(refund has not been made yet), FAI - order was cancelled, refund was made if it was available for the order, EXP - order expired  
+
*status (PAI - Order was purchased but not been requested yet, REQ - order has been requested, it can be under internal pre-validation or sent to CA, ACT - order is active, REJ- cancel was requested for the order, but has not been finished(refund has not been made yet), FAI - order was cancelled, refund was made if it was available for the order, EXP - order expired. Be default FAI orders are not returned in the response.
or array of some of them)
or array of some of them)
*contactHandle
*contactHandle

Revision as of 08:48, 17 April 2018

Contents

Module SSL certificates > Search Order

Module SSL certificates
Command name searchOrderSslCertRequest
Use Returns a list of SSL certificate orders matching search criteria
Input
  • limit default value: 100, maximum value: 1000
  • offset default value: 0
  • commonNamePattern
  • status (PAI - Order was purchased but not been requested yet, REQ - order has been requested, it can be under internal pre-validation or sent to CA, ACT - order is active, REJ- cancel was requested for the order, but has not been finished(refund has not been made yet), FAI - order was cancelled, refund was made if it was available for the order, EXP - order expired. Be default FAI orders are not returned in the response.

or array of some of them)

  • contactHandle
Output Result set of SSL certificate order details:
  • id
  • commonName
  • productName
  • brandName
  • status
  • orderDate
  • activeDate
  • expirationDate
  • hostNames
  • organizationHandle
  • administrativeHandle
  • technicalHandle
  • billingHandle
  • emailApprover
  • csr
  • certificate
  • rootCertificate
  • domainValidationMethods
  • domainValidationStatuses (raw array returned by CA)
  • autorenew
  • csrHashes (array of MD5 and SHA1 hashes required for non-email based validation)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchOrderSslCertRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'orderBy' => array(
      'expirationDate' => 'asc'
    )
  ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider. 

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <searchOrderSslCertRequest>
    <orderBy>
      <expirationDate>asc</expirationDate>
    </orderBy>
  </searchOrderSslCertRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <results>
        <array>
          <item>
            <id>1039</id>
            <commonName>openprovider.nl</commonName>
            <productName>Secure Site Pro with EV</productName>
            <brandName>VeriSign</brandName>
            <status>ACT</status>
            <orderDate>2009-02-13 12:34:12</orderDate>
            <activeDate>2009-02-18 15:51:23</activeDate>
            <expirationDate>2011-02-13 13:57:31</expirationDate>
            <hostNames></hostNames>
            <organizationHandle>SR003191-NL</organizationHandle>
            <administrativeHandle>SR003191-NL</administrativeHandle>
            <technicalHandle>SR003391-NL</technicalHandle>
            <billingHandle>SR003391-NL</billingHandle>
            <emailApprover>ssladmin@openprovider.nl</emailApprover>
            <csr>-----BEGIN CERTIFICATE REQUEST-----
MIIB2jCCAUMCAQAwgZkxCzAJBgNVBAYTAlNSMRMwEQYDVQQIEwpQYXJhbWFyaWJv
MRMwEQYDVQQHEwpQYXJhbWFyaWJvMRkwFwWDVQQKExBIb3N0aW5nIENvbmNlcHRz
MRswGQYDVQQDExJ3d3cubmlub25hYmFzLmluZm8xKDAmBgkqhkiG9w0BCQEWGW5p
bm9uQGhvc3RpbmctY29uY2VwdHMubmwwgQ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJ
AoGBAK0WTGoqkJ6FXPquwObSUUAbSi4xaYEnFntObBK+q0lGOHiWIiFOueIfqg/y
c7ZEjLBKdWXd3xb48pcWWvUHUHAl+2xCW+2xIIcYRDGmiqmus8Ed9wflrm7W5wFm
0zSxj/W6LlVX5ZrdXA+tr3WSLTC/xsE41BQ3fInxFN9hzspjAgMBAAGgADANBgkq
hkiG9w0BAQUFAAOBgQBMWx/JmwvYqT7PnalI9KosOreIkr/6gc+UIIY1GX8KBBJ9
wxFBO6W8vgvy8vwrbOhJVXq1RUwqvCMJED061LxG9rQBkJ6coGMhLN8iT1xgRi9i
nwLcoimwyyGwMKNscIAKgeiKNpXhBRHyjOP+pXGeaTsWicctWKGe67kbPl/dbA==
-----END CERTIFICATE REQUEST-----</csr>
            <certificate>-----BEGIN CERTIFICATE-----
MIIDYTCCAsqgAwIBAgIDDxwJMA0GCSqGSIb3DQEBBQUAME4xCzAJBgNVBAYTAlVT
MRAwDgYDVQQKEwdFcXVpZmF4MS0wKwYDVQQLEyRFcXVpZmF4IFNlY3VyZSBDZXJ0
aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwMjAxMDA0MzU2WhcNMTEwMjAyMjEwMTQ2
WjCB6zEpMCcGA1UEBRMgTHNaN3FvREFGWG5wMmNtV3h1N2kxVmltaDhmLVJHaEgx
CzAJBgNVBAYTAlNSMRswGQYDVQQKExJ5d3cubmlub25hYmFzLmluZm8xEzARBgNV
BAsTCkdUNjQ3OTAwMTExMTAvBgNVBAsTKFNlZSB3d3cucmFwaWRzc2wuY29tL3Jl
c291cmNlcy9jcHMgKGMpMTAxLzAtBgNVBAsTJkRvbWFpbiBDb250cm9sIFZhbGlk
YXRlZCAtIFJhcGlkU1NMKFIpMRswVQYDVQQDExJ3d3cubmlub25hYmFzLmluZm8w
gZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAK0WTGoqkJ6FXPquwObSUUAbSi4x
uYEnFntObBK+q0lGOHiWIiFOueIfqg/yc7ZEjLBKdWXd3xb48pcWWvUHUHAl+2xC
W+2xIIcYRDGmiqmus8Ed9wflam7W5wFm0zSxj/W6LlVX5ZrdXA+tr3WSLTC/xsE4
7BQ3fInxFN9hzspjAgMBAAGjga4wgaswDgYDVR0PAQH/BAQDAgTwMB0GA1UdDgQW
BBR1NEfvt2/xCmZNjSa1R6w+iPStsjA6BgNVHR8EMzAxMC+gLaArhilodHRwOi8v
Y3JsLmdlb3RydXN0LmNvbS9jcmxzL3NlY3VyZWNhLmNybDAfBgNVHSMEGDAWgBRI
5mj5K9KylddH2CMgEE8zmJCf1DAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUH
AwIwDQYJKoZIhvcNAQEFBQADgYEAQ+tAe6BZMwzciC6Y8vw1AXbXL8Oe1lKuI7ov
eGt30SQkVy3QRMSfbT7MQQy+cybE34xLY3GHXhTxV81d221eatgNRnz0lqg/RF5W
VbuD8DC8ZDclv0vd5aLK9SxlOP2VSqmJfgBBr4QVQ7igEue3s0jCzMch4v0j1Aap
OyY/SqY=
-----END CERTIFICATE-----</certificate>
            <rootCertificate>-----BEGIN CERTIFICATE-----
MIIDIDCCAomgAwIBAgIENd70zzANBgkqhkiG9w0BAQUFADBOMQswCQYDVQQGEwJV
UzEQMA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2Vy
dGlmaWNhdGUgQXV0aG9yaXR5MB4XDTk4MDgyMjE2NDE1MVoXDTE4MDgyMjE2NDE1
MVowTjELMAkGA1UEBhMCVVMxEDAOBgNVBAoTB0VxdWlmYXgxLTArBgNVBAsTJEVx
dWlmYXggU2VjdXJlIENlcnRpZmljYXRlIEF1dGhvcml0eTCBnzANBgkqhkiG9w0B
AQEFAAOBjQAwgYkCgYEAwV2xWGcIYu3gmi0fCG2RFGiYCh7+2gRvE4RiIcPRfM6f
BeC4AfBONOziipUEZKzxa1NfBbPLZ4C/QgKO/t0BCezhABRP/PvwDN1Dulsr4R+A
cJkVV5MW8Q+XarfCaCMczE1ZMKxRHjuvK9buY0V7xdlfUNLjUA86iOe/FP3gx7kC
AwEAAaOCAQkwggEFMHAGA1UdHwRpMGawZaBjoGGkXzBdMQswCQYDVQQGEwJVUzEQ
MA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2VydGlm
aWNhdGUgQXV0aG9yaXR5MQ0wCwYDVQRDEwRDUkwxMBoGA1UdEAQTMBGBDzIwMTgw
ODIyMTY0MTUxWjALBgNVHQ8EBAMCAQYwHwYDVR0jBBgwFoAUSOZo+SvSspXXR9gj
IBBPM5iQn9QwHQYDVR0OBBYEFEjmaPkr0rKV10fYIyAQTzOYkJ/UMAwGA1UdEwQF
MAMBAf8wGgYJKoZIhvZ9B0EABA0wCxsFVjMuMGMDAgbAMA0GCSqGSIb3DQEBBQUA
A4GBAFjOKer89961zgK5F7WF0bnj4JXMJTENAKaSbn+2kmOeUJXRmm/kEd5jhW6Y
7qj/WsjTVbJmcVfewCHrPSqnI0kBBIZCe/zuf6IWUrVnZ9NA2zsmWLIodz2uFHdh
1voqZiegDfqnc1zqcPGUIWVEY/r87yloqaKHee9570+sB3c4
-----END CERTIFICATE-----</rootCertificate>
              <autorenew>on</autorenew>
          </item>
          <item>
            <id>1044</id>
            <commonName>openprovider.co.uk</commonName>
            <productName>Secure Site Pro with EV</productName>
            <brandName>VeriSign</brandName>
            <status>ACT</status>
            <orderDate>2009-02-13 13:22:48</orderDate>
            <activeDate>2009-02-21 15:51:23</activeDate>
            <expirationDate>2011-02-15 13:57:31</expirationDate>
            <hostNames></hostNames>
            <organizationHandle>SR003191-NL</organizationHandle>
            <administrativeHandle>SR001191-NL</administrativeHandle>
            <technicalHandle>SR003391-NL</technicalHandle>
            <billingHandle>SR003391-NL</billingHandle>
            <emailApprover>ssladmin@openprovider.nl</emailApprover>
            <csr>-----BEGIN CERTIFICATE REQUEST-----
MIIB2jCCAUMCAQAwgZkxCzAJBgNVBAYTAlNSMRMwEQYDVQQIEwpQYXJhbWFyaWJv
MRMwEQYDVQQHEwpQYXJhbWFyaWJvMRkwFwWDVQQKExBIb3N0aW5nIENvbmNlcHRz
MRswGQYDVQQDExJ3d3cubmlub25hYmFzLmluZm8xKDAmBgkqhkiG9w0BCQEWGW5p
bm9uQGhvc3RpbmctY29uY2VwdHMubmwwgQ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJ
AoGBAK0WTGoqkJ6FXPquwObSUUAbSi4xaYEnFntObBK+q0lGOHiWIiFOueIfqg/y
c7ZEjLBKdWXd3xb48pcWWvUHUHAl+2xCW+2xIIcYRDGmiqmus8Ed9wflrm7W5wFm
0zSxj/W6LlVX5ZrdXA+tr3WSLTC/xsE41BQ3fInxFN9hzspjAgMBAAGgADANBgkq
hkiG9w0BAQUFAAOBgQBMWx/JmwvYqT7PnalI9KosOreIkr/6gc+UIIY1GX8KBBJ9
wxFBO6W8vgvy8vwrbOhJVXq1RUwqvCMJED061LxG9rQBkJ6coGMhLN8iT1xgRi9i
nwLcoimwyyGwMKNscIAKgeiKNpXhBRHyjOP+pXGeaTsWicctWKGe67kbPl/dbA==
-----END CERTIFICATE REQUEST-----</csr>
            <certificate>-----BEGIN CERTIFICATE-----
MIIDYTCCAsqgAwIBAgIDDxwJMA0GCSqGSIb3DQEBBQUAME4xCzAJBgNVBAYTAlVT
MRAwDgYDVQQKEwdFcXVpZmF4MS0wKwYDVQQLEyRFcXVpZmF4IFNlY3VyZSBDZXJ0
aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwMjAxMDA0MzU2WhcNMTEwMjAyMjEwMTQ2
WjCB6zEpMCcGA1UEBRMgTHNaN3FvREFGWG5wMmNtV3h1N2kxVmltaDhmLVJHaEgx
CzAJBgNVBAYTAlNSMRswGQYDVQQKExJ5d3cubmlub25hYmFzLmluZm8xEzARBgNV
BAsTCkdUNjQ3OTAwMTExMTAvBgNVBAsTKFNlZSB3d3cucmFwaWRzc2wuY29tL3Jl
c291cmNlcy9jcHMgKGMpMTAxLzAtBgNVBAsTJkRvbWFpbiBDb250cm9sIFZhbGlk
YXRlZCAtIFJhcGlkU1NMKFIpMRswVQYDVQQDExJ3d3cubmlub25hYmFzLmluZm8w
gZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAK0WTGoqkJ6FXPquwObSUUAbSi4x
uYEnFntObBK+q0lGOHiWIiFOueIfqg/yc7ZEjLBKdWXd3xb48pcWWvUHUHAl+2xC
W+2xIIcYRDGmiqmus8Ed9wflam7W5wFm0zSxj/W6LlVX5ZrdXA+tr3WSLTC/xsE4
7BQ3fInxFN9hzspjAgMBAAGjga4wgaswDgYDVR0PAQH/BAQDAgTwMB0GA1UdDgQW
BBR1NEfvt2/xCmZNjSa1R6w+iPStsjA6BgNVHR8EMzAxMC+gLaArhilodHRwOi8v
Y3JsLmdlb3RydXN0LmNvbS9jcmxzL3NlY3VyZWNhLmNybDAfBgNVHSMEGDAWgBRI
5mj5K9KylddH2CMgEE8zmJCf1DAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUH
AwIwDQYJKoZIhvcNAQEFBQADgYEAQ+tAe6BZMwzciC6Y8vw1AXbXL8Oe1lKuI7ov
eGt30SQkVy3QRMSfbT7MQQy+cybE34xLY3GHXhTxV81d221eatgNRnz0lqg/RF5W
VbuD8DC8ZDclv0vd5aLK9SxlOP2VSqmJfgBBr4QVQ7igEue3s0jCzMch4v0j1Aap
OyY/SqY=
-----END CERTIFICATE-----</certificate>
            <rootCertificate>-----BEGIN CERTIFICATE-----
MIIDIDCCAomgAwIBAgIENd70zzANBgkqhkiG9w0BAQUFADBOMQswCQYDVQQGEwJV
UzEQMA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2Vy
dGlmaWNhdGUgQXV0aG9yaXR5MB4XDTk4MDgyMjE2NDE1MVoXDTE4MDgyMjE2NDE1
MVowTjELMAkGA1UEBhMCVVMxEDAOBgNVBAoTB0VxdWlmYXgxLTArBgNVBAsTJEVx
dWlmYXggU2VjdXJlIENlcnRpZmljYXRlIEF1dGhvcml0eTCBnzANBgkqhkiG9w0B
AQEFAAOBjQAwgYkCgYEAwV2xWGcIYu3gmi0fCG2RFGiYCh7+2gRvE4RiIcPRfM6f
BeC4AfBONOziipUEZKzxa1NfBbPLZ4C/QgKO/t0BCezhABRP/PvwDN1Dulsr4R+A
cJkVV5MW8Q+XarfCaCMczE1ZMKxRHjuvK9buY0V7xdlfUNLjUA86iOe/FP3gx7kC
AwEAAaOCAQkwggEFMHAGA1UdHwRpMGawZaBjoGGkXzBdMQswCQYDVQQGEwJVUzEQ
MA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2VydGlm
aWNhdGUgQXV0aG9yaXR5MQ0wCwYDVQRDEwRDUkwxMBoGA1UdEAQTMBGBDzIwMTgw
ODIyMTY0MTUxWjALBgNVHQ8EBAMCAQYwHwYDVR0jBBgwFoAUSOZo+SvSspXXR9gj
IBBPM5iQn9QwHQYDVR0OBBYEFEjmaPkr0rKV10fYIyAQTzOYkJ/UMAwGA1UdEwQF
MAMBAf8wGgYJKoZIhvZ9B0EABA0wCxsFVjMuMGMDAgbAMA0GCSqGSIb3DQEBBQUA
A4GBAFjOKer89961zgK5F7WF0bnj4JXMJTENAKaSbn+2kmOeUJXRmm/kEd5jhW6Y
7qj/WsjTVbJmcVfewCHrPSqnI0kBBIZCe/zuf6IWUrVnZ9NA2zsmWLIodz2uFHdh
1voqZiegDfqnc1zqcPGUIWVEY/r87yloqaKHee9570+sB3c4
-----END CERTIFICATE-----</rootCertificate>
             <autorenew>on</autorenew>
          </item>
        </array>
      </results>
      <total>2</total>
    </data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_SSL_searchOrderSslCertRequest"
Views
Personal tools