CatalogAvailability
Catalog availability
New endpoint available: Catalog/Availability
Introduction
The catalog availability allows you to know if the catalog is available or not on TraceParts.
API Key
This web service requires an API Key. Please use the form to request your API Key.
Description
This API returns if a catalog is available. If it is, the ID of the catalog and the date of the last update are also returned.
Building a URL
The CatalogAvailability API request takes the following form:
https://ws.tracepartsonline.net/tpowebservices/CatalogAvailability?parameters
Parameters
Certain parameters are required while others are optional. As it is standard in URLs, all parameters are separated using the ampersand (&) character. The list of parameters and their possible values are enumerated below.
Required parameters
Parameter Name | Data type | Default value | Description |
---|---|---|---|
ApiKey | string | none | Code calling an API to track and control how the API is used |
Format | string | none | Answer file type (xml, json) |
Catalog | string | none | Label of the catalog as the requester knows it. TraceParts handles a list of aliases to match with our internal IDs |
Version | integer | 1 | Version of the answer |
Optional parameters
Parameter Name | Data type | Default value | Description |
---|---|---|---|
UserEmail | string | none | User email / User ID |
ActiveJsonLight | boolean | 0 | Enables the light version when json is the answer file type |
Example of CatalogAvailability API
The request below returns the availability of the “Schaeffler” catalog, known as “INAFAG” catalogID in the TraceParts database, as an xml file.
https://ws.tracepartsonline.net/tpowebservices/CatalogAvailability?Catalog=schaeffler&Format=xml&ApiKey={ApiKey}&Version=2
By changing the Format and adding the ActiveJsonLight, CatalogAvailability returns the availability as a light Json file.
https://ws.tracepartsonline.net/tpowebservices/CatalogAvailability?Catalog=schaeffler&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}&Version=2
CatalogAvailability responses
CatalogAvailability responses are returned in the Format indicated by the Format parameter within the URL request’s path.
JSON Output
A sample HTTP request is shown below, displaying the availability of a catalog.
{
"availability":true
"catalogList":
[{
"classificationId":"INAFAG"
"updated":"2017-10-24 22:00:00Z"
}]
}
XML Output
Same example as above.
<WsCatalogListAvailability>
<Availability>true</Availability>
<CatalogList>
<WsCatalogAvailability>
<ClassificationId>INAFAG</ClassificationId>
<Updated>2017-10-24 22:00:00Z</Updated>
</WsCatalogAvailability>
</CatalogList>
</WsCatalogListAvailability>
CatalogAvailability response elements
CatalogAvailability responses contain three elements:
- “Availability”: true or false if the catalog is available or not on the TraceParts database.
- “ClassificationId”: TraceParts ID for the catalog. It is 33 characters maximum (A through Z, 0 through 9 and – and _ ).
- “Updated”: date (ISO 8601 format YYYY-MM-DDThh:mm:ss.sTZD) of the last update of a product of the catalog.
Developer support
Please contact us for any problem, question or comment related to this content integration.
Last updated October 26, 2017
Updated 7 months ago