get_product_info

Queries the properties of the specified SSL Service product.

Request parameters for get_product_info

Standard parameters

  • action = get_product_info
  • object = trust_service

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

all_info

Optional

If included and set to 1, the response includes the CSR and contact information. If the certificate was migrated from TPP, the response includes
the TPP order ID and inventory ID.

inventory_item_id

Optional; may be used for
certificates that were migrated
from TPP.

The certificate product ID number that was used in the TPP system.

This value may be used in place of product_id.

product_id

Required

The SSL Service ID number.

Note: This value is not required for certificates that were migrated from TPP if inventory_item_id is submitted.

Response parameters for get_product_info

Standard parameters

  • action = reply
  • object = trust_service
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

If the request is successful, the attributes associative array may include the
following:

Parameter name

Obligation

Definition/Value

contact_email

Returned if is_success = true

The administrator email address.

csr

Returned if is_success = true

Certificate Signing Request. The SSL Service provider uses this information generate the certificate.

domain

Returned if is_success = true

The domain with which the SSL Service is
associated.

expiry_date

Returned if is_success = true

The date that the SSL Service certificate expires.

inventory_item_id

Returned if is_success = true and cert was migrated from TPP

The certificate product ID number that was
used in the TPP system.

is_renewable

Returned if is_success = true

Indicates whether the product is can be renewed at this time. SSL Service products can be renewed between 60 days
before the expiry date and 15 days after expiry date.

Allowed values are:

  • 0—Product cannot be renewed at
    this time.

  • 1—Product can be renewed.

issue_date

Returned if is_success = true

The date that the SSL Service certificate was issued.

product_id

Returned if is_success = true

The ID number for the SSL Service.

product_type

Returned if is_success = true

The product type from the SSL Certificate inventory. The product types are detailed in
the allowed values section for this key.

Allowed values are:

  • comodo_ev

  • comodo_instantssl

  • comodo_premiumssl

  • comodo_premiumssl_wildcard

  • comodo_ssl

  • comodo_wildcard

  • essentialssl

  • essentialssl_wildcard

  • positivessl

  • malwarescan

  • quickssl

  • quickssl_premium

  • securesite

  • securesite_pro

  • securesite_ev

  • securesite_pro_ev

  • sgcsuper_certs

  • sitelock_basic

  • sitelock_premium

  • sitelock_enterprise

  • sitelock_find

  • sitelock_fix

  • sitelock_prevent

  • sitelock_911

  • ssl123

  • essentialssl_wildcard

  • sslwebserver

  • sslwebserver_wildcard

  • sslwebserver_ev

  • symantec_ssl_lite

  • symantec_ssl_lite_wildcard

  • truebizid

  • truebizid_wildcard

  • truste_hpp (Hosted Privacy Policy)

  • truste_tps (TRUSTE Privacy Policy
    with seal)

  • truebizid_ev

  • trustwave_dv

  • trustwave_ev

  • trustwave_premiumssl

  • trustwave_premiumssl_wildcard

start_date

Returned if is_success = true

The effective date for the SSL Service.

state

Returned if is_success = true

The state of the product. Allowed values are:

  • expired

  • active

  • renewing

  • renewed

  • revoked

tpp order_id

Returned if cert was migrated from TPP and is_success = true

The order number that was used in the TPP system.

upgrade_options

Returned if is_success = true
and product_type = sitelock_find
or sitelock_fix

Indicates the product types to which the existing product can be upgraded.

Currently, this applies to Sitelock products only.

If product_type = sitelock_find, values returned are sitelock_fixand sitelock_prevent; if product_type = sitelock_fix, value returned is sitelock_prevent.

Examples for get_product_info

Example 1

Retrieves the properties for a SSL Service product.

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">get_product_info</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="product_id">99</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">TRUST_SERVICE</item>
                <item key="is_success">1</item>
                <item key="response_text">Command completed
successfully.</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="product_type">truebizid_wildcard</item>
                        <item key="issue_date">2010-09-14-04:00</item>
                        <item key="domain">*.example.com</item>
                        <item key="product_id">99</item>
                        <item key="contact_email">[email protected]</item>
                        <item key="start_date">2010-09-13-04:00</item>
                        <item key="expiry_date">2010-09-22-04:00</item>
                        <item key="is_renewable">0</item>
                        <item key="state">expired</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

Retrieves all information for a SSL Service product.

<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">get_product_info</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="all_info">1</item>
                        <item key="product_id">6015</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">TRUST_SERVICE</item>
                <item key="response_text">Command completed successfully.</item>
                <item key="action">GET_PRODUCT_INFO:REPLY</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="csr_data">
                            <dt_assoc>
                                <item key="country">US</item>
                                <item key="organization_unit">Support</item>
                                <item key="valid_true_domain">1</item>
                                <item key="state">California</item>
                                <item key="locality">Santa Clara</item>
                                <item key="email"></item>
                                <item key="domain">example.com</item>
                                <item key="valid_quick_domain">1</item>
                                <item key="has_bad_extensions">0</item>
                                <item key="organization">Example Inc.</item>
                            </dt_assoc>
                        </item>
                        <item key="notes_list">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="date">2016-04-18T00:20:04.000-04:00</item>
                                        <item key="type">product_active</item>
                                        <item key="note">The product with the id [6015] has been created.</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                        <item key="expiry_date">2017-04-18T19:59:59.000-04:00</item>
                        <item key="state">active</item>
                        <item key="product_type">quickssl</item>
                        <item key="domain">example.com</item>
                        <item key="issue_date">2016-04-17T23:48:52.000-04:00</item>
                        <item key="product_id">6015</item>
                        <item key="is_renewable">0</item>
                        <item key="contact_email">[email protected]</item>
                        <item key="contact_set">
                            <dt_assoc>
                                <item key="organization">
                                    <dt_assoc>
                                        <item key="country">US</item>
                                        <item key="org_name">Example Inc.</item>
                                        <item key="phone">+1.4165550123</item>
                                        <item key="last_name">Ottway</item>
                                        <item key="address2">Suite 500</item>
                                        <item key="state">CA</item>
                                        <item key="email">[email protected]</item>
                                        <item key="city">SomeCity</item>
                                        <item key="postal_code">90210</item>
                                        <item key="fax">+1.4165550124</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="first_name">Owen</item>
                                        <item key="title">Organization</item>
                                    </dt_assoc>
                                </item>
                                <item key="admin">
                                    <dt_assoc>
                                        <item key="country">US</item>
                                        <item key="org_name">Example Inc.</item>
                                        <item key="phone">+1.4165550123</item>
                                        <item key="last_name">Adams</item>
                                        <item key="address2">Suite 100</item>
                                        <item key="state">CA</item>
                                        <item key="email">[email protected]</item>
                                        <item key="city">Santa Clara</item>
                                        <item key="postal_code">90210</item>
                                        <item key="fax">+1.4165550125</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="first_name">Adler</item>
                                        <item key="title">Admin</item>
                                    </dt_assoc>
                                </item>
                                <item key="billing">
                                    <dt_assoc>
                                        <item key="country">US</item>
                                        <item key="org_name">Example Inc.</item>
                                        <item key="phone">+1.4165550123</item>
                                        <item key="last_name">Burton</item>
                                        <item key="address2">Suite 200</item>
                                        <item key="state">CA</item>
                                        <item key="email">[email protected]</item>
                                        <item key="city">Santa Clara</item>
                                        <item key="postal_code">90210</item>
                                        <item key="fax">+1.4165550136</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="first_name">Bill</item>
                                        <item key="title">Billing</item>
                                    </dt_assoc>
                                </item>
                                <item key="tech">
                                    <dt_assoc>
                                        <item key="country">US</item>
                                        <item key="org_name">Example Inc.</item>
                                        <item key="phone">+1.4165550123</item>
                                        <item key="last_name">Wayne</item>
                                        <item key="address2">Suite 200</item>
                                        <item key="state">CA</item>
                                        <item key="email">[email protected]</item>
                                        <item key="city">Santa Clara</item>
                                        <item key="postal_code">90210</item>
                                        <item key="fax">+1.4165550136</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="first_name">Thomas</item>
                                        <item key="title">Tech</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="csr">
                -----BEGIN CERTIFICATE REQUEST-----
                MIICuzCCAaMCADB3MQswCQYDVQQGEwJVUzEUMBIGA1UEAxMLZXhhbXBsZS5jb20x
                FDASBgNVBAcTC1NhbnRhIENsYXJhMRUwEwYDVQQKEwxFeGFtcGxlIEluYy4xEzAR
                BgNVBAgTCkNhbGlmb3JuaWExEDAOBgNVBAsTB1N1cHBvcnQwggEiMA0GCSqGSIb3
                DQEBAQUAA4IBDwAwggEKAoIBAQDTCJ1qnH3gaKVd8VXTOx5GR+MYinU36Z9psxuG
                haMZ70qhTwng5zcbC93XIpAJRkbMwMu1EI10QDNi91Z4ORI9ExbBg0HBrAz+k85O
                lMUk1xTR8FQ8eHWXLnL3uXDevi5XMsb0ASB6wADDdvVm2Eb4qu+B1KD5qCSPiRJ2
                FLeNNI3JNosmKmtmhqgy6+0qYYTP5RPFJeIu55cvX+r9ghiL11eBg/A+3RBhLdLR
                +z0CsngOFMlNxzmP0csINw4FIj4AoAkMiA/2Hf6rT6bHiAtJDbkW6jAS3AQjB1IC
                LlkFbr12e5P7USqSsKSbwslOHHBJpfYceA6582MI4ZZ3CerNAgMBAAGgADANBgkq
                hkiG9w0BAQsFAAOCAQEAaUwWHGCekeDC9U0OqLHlaXT9yRTpBcMu3waqWWhIgxLP
                6ut1YlYjz1yAc7XIJPNo+uyXX1BtrMpGgXt7cJmwLeXPHHs1WoleQfKOGjVRf3+8
                sQgdVroMR8HtOPid00Vxd4v1caUQtM7N2e2sWe5IL5OS2ziAflc3UhSoLu7JQwNg
                pKCQbOVbq5Y+uWYmMkKaZewIiziUvqngUMgA2ci+BJ2xCZmq00Leq+AZMLKPI2NE
                NcKsc4yjB4envG4vzc4qMFQakvH0uvsswZc80H7R7neThUgpfQM+PhDI/z3woTPG
                exAECZo+AqWhnwdut/Socu+aFkMO0vl77JD4acjODA==
                -----END CERTIFICATE REQUEST-----
            </item>
                        <item key="let_expire">0</item>
                        <item key="upgrade_options"></item>
                        <item key="start_date">2016-04-17T20:00:00.000-04:00</item>
                    </dt_assoc>
                </item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 3

Retrieves all information for a SSL Service product that was migrated from
the TPP system.

<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">get_product_info</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="all_info">1</item>
                        <item key="product_id">2076</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">TRUST_SERVICE</item>
                <item key="response_text">Command completed successfully.</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="tpp_order_id">9997602</item>
                        <item key="csr_data">
                            <dt_assoc>
                                <item key="country">US</item>
                                <item key="organization_unit">QA Dept</item>
                                <item key="valid_true_domain">1</item>
                                <item key="state">CA</item>
                                <item key="locality">Santa Clara</item>
                                <item key="email">[email protected]</item>
                                <item key="domain">renewtest.example.org</item>
                                <item key="valid_quick_domain">1</item>
                                <item key="has_bad_extensions">0</item>
                                <item key="organization">Example Co.</item>
                            </dt_assoc>
                        </item>
                        <item key="notes_list">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="date">2012-04-12T11:20:11.000-
05:00</item>
                                        <item key="type">product_active</item>
                                        <item key="note">The product with the id [2076] has
been created.</item>
                                    </dt_assoc>
                                </item>
                                <item key="1">
                                    <dt_assoc>
                                        <item key="date">2012-04-12T11:20:59.000-
05:00</item>
                                        <item key="type">product_renewing</item>
                                        <item key="note">The product with the id [2076] is
in the process
of being renewed.</item>
                                    </dt_assoc>
                                </item>
                                <item key="2">
                                    <dt_assoc>
                                        <item key="date">2012-04-12T11:25:07.000-
05:00</item>
                                        <item key="type">product_renewed</item>
                                        <item key="note">The product with the id [2076] has
been renewed.</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                        <item key="expiry_date">2012-04-19T20:46:39.000-05:00</item>
                        <item key="inventory_item_id">8887602</item>
                        <item key="state">renewed</item>
                        <item key="product_type">quickssl</item>
                        <item key="domain">renewtest.example.org</item>
                        <item key="issue_date">2012-04-12T11:19:11.000-05:00</item>
                        <item key="product_id">2076</item>
                        <item key="is_renewable">0</item>
                        <item key="contact_email">[email protected]</item>
                        <item key="contact_set">
                            <dt_assoc>
                                <item key="admin">
                                    <dt_assoc>
                                        <item key="first_name">Adler</item>
                                        <item key="last_name">Adams</item>
                                        <item key="title">Administrator</item>
                                        <item key="org_name">Example Co.</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="address2">Suite 100</item>
                                        <item key="address3" />
                                        <item key="city">Santa Clara</item>
                                        <item key="state">CA</item>
                                        <item key="postal_code">90210</item>
                                        <item key="country">US</item>
                                        <item key="phone">+1.4165550123x1812</item>
                                        <item key="fax">+1.4165550125</item>
                                        <item key="email">[email protected]</item>
                                    </dt_assoc>
                                </item>
                                <item key="tech">
                                    <dt_assoc>
                                        <item key="first_name">Ted</item>
                                        <item key="last_name">Tucker</item>
                                        <item key="title" />
                                        <item key="org_name">Example Co.</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="address2">Suite 100</item>
                                        <item key="address3" />
                                        <item key="city">Santa Clara</item>
                                        <item key="state">CA</item>
                                        <item key="postal_code">90210</item>
                                        <item key="country">US</item>
                                        <item key="phone">+1.4165550123x1243</item>
                                        <item key="fax">+1.4165550125</item>
                                        <item key="email">[email protected]</item>
                                    </dt_assoc>
                                </item>
                                <item key="organization">
                                    <dt_assoc>
                                        <item key="first_name">Jim</item>
                                        <item key="last_name">Johnson</item>
                                        <item key="title">Director</item>
                                        <item key="org_name">Example Co.</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="address2">Suite 100</item>
                                        <item key="address3" />
                                        <item key="city">Santa Clara</item>
                                        <item key="state">CA</item>
                                        <item key="country">US</item>
                                        <item key="postal_code">90210</item>
                                        <item key="phone">+1.4165550123x1224</item>
                                        <item key="email">[email protected]</item>
                                        <item key="fax">+1.4165550126</item>
                                    </dt_assoc>
                                </item>
                                <item key="billing">
                                    <dt_assoc>
                                        <item key="first_name">Bill</item>
                                        <item key="last_name">Burton</item>
                                        <item key="title" />
                                        <item key="org_name">Example Co.</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="address2">Suite 200</item>
                                        <item key="address3" />
                                        <item key="city">Santa Clara</item>
                                        <item key="state">CA</item>
                                        <item key="country">US</item>
                                        <item key="postal_code">90210</item>
                                        <item key="phone">+1.4165550123x1248</item>
                                        <item key="fax">+1.4165550136</item>
                                        <item key="email">[email protected]</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                        <item key="csr">-----BEGIN CERTIFICATE REQUEST-----
MIIC3DCCAcQCAQAwgZYxIzAhBgNVBAMTGnJlbmV3dGVzdC5xYXJlZ3Jlc3Npb24ub3JnMQs
wCQYDVQQGEwJDQTELMAkGA1UECBMCT04xEDAOBgNVBAcTB1Rvcm9udG8x
DzANBgNVBAoTBlR1Y293czEQMA4GA1UECxMHUUEgRGVwdDEgMB4GCSqGSIb3DQEJARYRcWF
maXZlQHR1Y293cy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK
AoIBAQDS7+XQflaRIXlWlRv9MRwa5vidu4uKciZdthDVkWo50lYPVZcwSY1v5bhTwIGpGna
22ak3snH+GDcYKqy9umY0cVbJRM16jsWNiVc4xgylR6JD/rGxG7DVlUu/
qJK1T8tl09PGLz9yRWnLSb9BbZ85tRgq1+up57/O4zXNgznRZhxibr5mgb4w/5yWga/elUa
t6GJNLsbvZo+k516JgCk2trudH9+tr72454T8ZR5fbdw23GruqvQGilUY
UsKe1Uywv8vgml1AIGTPctPwfxcFhRPMdWbZ/YmmaxNvd1/DBXZKL8F0wh672aGNEx5DXTk
so2tVPwpadgyLJFqMaHdzAgMBAAGgADANBgkqhkiG9w0BAQQFAAOCAQEA
YYLY/3lGaxxxQASKwm4mUY4QAytqp24A0/i1OSOJNG86OOR8ws7VtFSGKa2B//gx6y2KAI6
zomWL4Zpl4DcD8ttckv343DqFwjzJWn5P5/uLBg1z1QVJfVXAyWOt7PQb
qx3EfaiVMgoHYCyQgXx50/iKg1w+k2Q2PUGPVJQFTBdXKBn5eaRJJW2JNJVhaNok9peAgsE
adXTUGMrKpU0iaExWTvHBN3v9jjF1tow/hhbUqBGk80OVb2MGsa5Rp5aP
WG8wWgI67EYcDe2IKvRfoPfzKw6WsLHq2GHp+qqJjXAUB4TBP3/cb3nIrAA8+h9lR3UCZ0L
yB0rQM7pkk0t9Jw== -----END CERTIFICATE REQUEST-----</item>
                        <item key="start_date">2012-04-11T09:02:43.000-05:00</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>