List sites with certificate tracking GET
Returns a list of all sites to which the authenticated user has access that are subscribers to certificate tracking services.
Response Parameters
| Parameter | Description |
| Sites List | The list of sites with certificate tracking subscriptions to which the user has accessOptional |
Identifier String
| The unique identifier associated with the site |
SiteName String
| The name of the site |
Postcode String
| The postcode for the site |
Country String
| The country of the site |
Subscriptions List
| The list of certificate tracking subscriptions available to the site |
Name String
| The name of the certificate tracking service subscription |
Schemes List
| The list of schemes whose certificates may be tracked through the subscription |
Scheme String
| The name of the certification scheme |
SchemeIdentifier String
| The unique identifier assigned to the certification scheme |
Tier Number
| The tier of the subscription. This is zero if service has no tiers or the subscription is on the top unlimitied tier |
EndDate Date / Time
| The date on which the subscription ends |
IsActive Boolean
| Flag indicating if this subscription is currently active. This is false if the end date has passed or the subscription has been suspended. |
Example Request
GET https://api.xure.co/v1/track/certificates.eb HTTP/1.1
Accept: text/xml
Response Schema
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="SiteListResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Sites" minOccurs="0">
<xsd:annotation>
<xsd:documentation>The list of sites with certificate tracking subscriptions to which the user has access</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Identifier" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The unique identifier associated with the site</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SiteName" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the site</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Postcode" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The postcode for the site</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Country" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The country of the site</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Subscriptions">
<xsd:annotation>
<xsd:documentation>The list of certificate tracking subscriptions available to the site</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Name" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the certificate tracking service subscription</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Schemes">
<xsd:annotation>
<xsd:documentation>The list of schemes whose certificates may be tracked through the subscription</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Scheme" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the certification scheme</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SchemeIdentifier" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The unique identifier assigned to the certification scheme</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="Tier" type="xsd:double">
<xsd:annotation>
<xsd:documentation>The tier of the subscription. This is zero if service has no tiers or the subscription is on the top unlimitied tier</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="EndDate" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>The date on which the subscription ends</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="IsActive" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>Flag indicating if this subscription is currently active. This is false if the end date has passed or the subscription has been suspended.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml
<?xml version="1.0" encoding="utf-8"?>
<SiteListResponse>
<Sites>
<Item>
<Identifier>xsd:string</Identifier>
<SiteName>xsd:string</SiteName>
<Postcode>xsd:string</Postcode>
<Country>xsd:string</Country>
<Subscriptions>
<Item>
<Name>xsd:string</Name>
<Schemes>
<Item>
<Scheme>xsd:string</Scheme>
<SchemeIdentifier>xsd:string</SchemeIdentifier>
</Item>...</Schemes>
<Tier>xsd:double</Tier>
<EndDate>xsd:dateTime</EndDate>
<IsActive>xsd:boolean</IsActive>
</Item>...</Subscriptions>
</Item>...</Sites>
</SiteListResponse>
Example Request
GET https://api.xure.co/v1/track/certificates.eb HTTP/1.1
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{"Sites":[{"Identifier":String,
"SiteName":String,
"Postcode":String,
"Country":String,
"Subscriptions":[{"Name":String,
"Schemes":[{"Scheme":String,
"SchemeIdentifier":String},
...],
"Tier":Number,
"EndDate":String,
"IsActive":Boolean},
...]},
...]}
Use the SiteIdentifier returned by this method as the site path parameter for both of the certificate tracking endpoints to obtain certification data for suppliers associated with the site.
Subscription Details
The results of this method also return more detail about the tracking services to which a site is subscribed. Each subscription lists the set of schemes for which certification data is provided. Use the SchemeIdentifier values given here to filter the data returned by the certificate tracking endpoints.
Where a service has multiple subscription tiers, the Tier returns a number indicating the current subscription level. Generally, this quantifies the maximum number of suppliers' certificates that may be tracked. If a service has no tiers, or when subscribed to the top 'unlimited' tier this shows as zero.
Top-tier subscribers have access to certification data across the entire scheme membership through the adhoc tracking endpoint without the need to have previously tagged the supplier through recording a trading relationship.