CatalogsList

List of catalogs

📘

New endpoint available: CatalogList

Introduction

The list of catalogs is related to your account, thanks to the API Key. It can vary from having only one catalog to all available catalogs in the TraceParts database.

API Key

This web service requires an API Key. Please use the form to request your API Key.

Description

The API returns the information related to the available catalogs, such as their TraceParts ID, their label, their logo and few other details.

Building a URL

The CatalogsList API request takes the following form:

https://ws.tracepartsonline.net/tpowebservices/CatalogsList?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 NameData typeDefault valueDescription
ApiKeystringnoneCode calling an API to track and control how the API is used
FormatstringnoneAnswer file type (xml, json)
LanguagestringenLanguageID given by the LanguagesList API
Versioninteger1Version of the answer

Optional parameters

Parameter NameData typeDefault valueDescription
UserEmailstringnoneUser email / User ID
ActiveJsonLightboolean0Enables the light version when json is the answer file type
SupplierInfoboolean0Provides some informations related to the supplier
httpsboolean0URL returned in the answer will use the https protocol

Example of CatalogsList API

The request below returns all catalogs as an xml file, with an English content.

https://ws.tracepartsonline.net/tpowebservices/CatalogsList?Language=en&Format=xml&ApiKey={ApiKey}&https=1&Version=2

By changing the Format and adding the ActiveJsonLight, CatalogsList returns all catalogs as a light Json file.

https://ws.tracepartsonline.net/tpowebservices/CatalogsList?Language=en&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}&https=1&Version=2

CatalogsList responses

CatalogsList 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 some of the available catalogs.

{
"classificationId":"ASCO_JOUCOMATIC",
"title":"ASCO Numatics"
"pictureUrl":"https://tracepartsonline.net/PartsDefs/Production/System/Pictures/ASCO_JOUCOMATICM.gif"
"published":"2002-02-19 23:00:00Z"
"updated":"2017-09-24 22:00:00Z"
"classType":"2"
},
{
"classificationId":"DIN",
"title":"DIN"
"pictureUrl":"https://tracepartsonline.net/PartsDefs/Production/System/Pictures/DINM.gif"
"published":"2007-08-19 22:00:00Z"
"updated":"2017-10-02 22:00:00Z"
"classType":"5"
},
{
"classificationId":"LEGRIS",
"title":"Parker Legris Connectic Low Pressure"
"pictureUrl":"https://tracepartsonline.net/PartsDefs/Production/System/Pictures/LEGRISM.gif"
"published":"2002-02-19 23:00:00Z"
"updated":"2017-10-18 22:00:00Z"
"classType":"2"
}

XML Output

Same example as above.

<WsClassification>
<ClassificationId>ASCO_JOUCOMATIC</ClassificationId>
<Title>ASCO Numatics</Title>
<PictureUrl>https://tracepartsonline.net/PartsDefs/Production/System/Pictures/ASCO_JOUCOMATICM.gif</PictureUrl>
<Published>2002-02-19 23:00:00Z</Published>
<Updated>2017-09-24 22:00:00Z</Updated>
<ClassType>2</ClassType>
</WsClassification>
<WsClassification>
<ClassificationId>DIN</ClassificationId>
<Title>DIN</Title>
<PictureUrl>https://tracepartsonline.net/PartsDefs/Production/System/Pictures/DINM.gif</PictureUrl>
<Published>2007-08-19 22:00:00Z</Published>
<Updated>2017-10-02 22:00:00Z</Updated>
<ClassType>5</ClassType>
</WsClassification>
<WsClassification>
<ClassificationId>LEGRIS</ClassificationId>
<Title>Parker Legris Connectic Low Pressure</Title>
<PictureUrl>https://tracepartsonline.net/PartsDefs/Production/System/Pictures/LEGRISM.gif</PictureUrl>
<Published>2002-02-19 23:00:00Z</Published>
<Updated>2017-10-18 22:00:00Z</Updated>
<ClassType>2</ClassType>
</WsClassification>

CatalogsList response elements

CatalogsList responses contain nine elements:

  • “classificationId”: TraceParts ID for the catalog. It is 33 characters maximum (A through Z, 0 through 9 and – and _ ).
  • “Title”: label of the catalog, depending on the language.
  • “PictureURL”: path to the catalog’s logo. It is 40 pixels high with a maximum width of 316 pixels. There is no minimum width.
  • “Published”: date (ISO 8601 format YYYY-MM-DDThh:mm:ss.sTZD) of the first publication, of the first product, of the catalog.
  • “Updated”: date (ISO 8601 format YYYY-MM-DDThh:mm:ss.sTZD) of the last update of a product of the catalog.
  • “ClassType”: type of catalogs. You can filter or sort the catalogs with this type (1: general catalogs with several suppliers | 2: supplier catalog | 3: dedicated classification for a specific customer | 4: user classification | 5: catalog of institute for standardization.
  • “SupplierName”: label of the catalog.
  • “SupplierDescription”: description of the catalog.
  • “RFQEnabled”: the supplier subscribed to the quotation feature thru the TracePartsOnline.net website.

Developer support

Please contact us for any problems, questions or comments related to this web service.

Last updated October 25, 2017