get_products
Request parameters for get_products
Standard parameters
- action = get_products
- object = trust_service
Attributes
Parameters within the attributes associative array are described below.
| Parameter name | Obligation | Definition/Value |
|---|---|---|
| max_expiry_date | Required | Used in conjunction with min_expiry_date attribute The latest expiry date to use to generate a list of Trust Service products. Date must be in the format YYYY-MM-DD. |
| min_expiry_date | Required | Used in conjunction with max_expiry_date attribute. The earliest expiry date to use to generate a list of Trust Service products. Date must be in the format YYYY-MM-DD. |
| state | Optional | The state of the Trust Service products that you want returned. Allowed values are: activated active expired renewed revoked upgraded |
Response parameters for get_products
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
Parameters within the attributes associative array are described below.
| Parameter name | Obligation | Definition/Value |
|---|---|---|
| product_list | Returned if is_success = true | An array that lists the products whose expiry dates are within a specific date range. For more information, see the product_list table below. |
product_list
Parameters within the product_list associative array are described below.
| Parameter name | Obligation | Definition/Value |
|---|---|---|
| contact_email | Returned if is_success = true | The email contact from the order. |
| domain | Returned if is_success = true | The domain or hostname to which the Trust Service applies. |
| expiry_date | Returned if is_success = true | The date that the Trust Service product expires. |
| is_renewable | Returned if is_success = true | Indicates whether the product is can be renewed at this time. Trust 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 Trust Service product was issued. |
| product_id | Returned if is_success = true | The ID number of the Trust Service product |
| product_type | Returned if is_success = true | The product type from the SSL Certificate inventory. 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_ev securesite_pro securesite_pro_ev sgcsuper_certs sitelock_basic sitelock_premium sitelock_enterprise sitelock_find sitelock_fix sitelock_prevent sitelock_911 ssl123 sslwebserver sslwebserver_ev sslwebserver_wildcard symantec_ssl_lite symantec_ssl_lite_wildcard truebizid truebizid_ev truebizid_wildcard truste_hpp (Hosted Privacy Policy) truste_tps (TRUSTE Privacy Policy with seal) trustwave_dv trustwave_ev trustwave_premiumssl * trustwave_premiumssl_wildcard |
| start_date | Returned if is_success = true | The effective date for the Trust Service. |
| state | Returned if is_success = true | The state of the Trust Service product. Allowed values are: approver-confirmed—Owner has confirmed the domain vetted certificate. awaiting-approval—Order processed successfully; waiting for supplier approval. cancelled —Pending order was cancelled. completed—Order is complete. declined—Order cancelled after it was processed or declined by the supplier. in-progress—Order is in progress. * pending—Order saved as pending. |
Examples for get_products
Request
<?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_products</item>
<item key="object">trust_service</item>
<item key="attributes">
<dt_assoc>
<item key="min_expiry_date">2012-04-23</item>
<item key="state">expired</item>
<item key="max_expiry_date">2012-09-22</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?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="attributes">
<dt_assoc>
<item key="product_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="expiry_date">2012-04-23T10:41:04.000-
04:00</item>
<item key="state">expired</item>
<item key="product_type">quickssl</item>
<item key="issue_date">2012-04-16T09:17:46.000-
04:00</item>
<item key="domain">example.org</item>
<item key="product_id">2094</item>
<item key="contact_email">[email protected]</item>
<item key="is_renewable">0</item>
<item key="start_date">2012-04-14T20:14:48.000-
04:00</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="expiry_date">2012-05-08T07:34:49.000-
04:00</item>
<item key="state">expired</item>
<item key="product_type">securesite_pro</item>
<item key="issue_date">2012-04-30T11:27:59.000-
04:00</item>
<item key="domain">example.net</item>
<item key="product_id">2096</item>
<item key="contact_email">[email protected]</item>
<item key="is_renewable">0</item>
<item key="start_date">2012-04-28T19:42:30.000-
04:00</item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Updated almost 8 years ago