webleads-tracker

Home > TraceParts for Developers > Data related to a Part Number

Introduction

This API provides all data related to a part number, such as the thumbnail, the Bill Of Materials, the CAD file, the supplier contact details, etc.

 

API Key

This web service requires an API Key. Please refer to this chapter to request your API Key.

 

Description

The API returns all available data for a specific part number for one given product. The list of items provided depends on the information given by the supplier. TraceParts cannot guarantee that the desired information will be available.

 

Building a URL

The PartNumberData API request takes the following form:

http://ws.tracepartsonline.net/tpowebservices/PartNumberData?parameters

 

Parameters

Certain parameters are required while others are optional. As 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

UserEmail

string

none

User email / User ID

Format

string

none

Answer file type (xml, json or csv)

Language

string

en

LanguageID given by the LanguagesList API

PartID*

string

none

PartID given by the SynchronizationData API

Optional parameters

Parameter Name

Data type

Default value

Description

CADFormatID

real

none

CADFormatID given by the CADFormatsList API

HtmlFormat

integer

0

Activates the html formatting of the optional description related to the part number

ActiveJsonLight

boolean

0

Enables the light version when json is the answer file type

SelectionPath*

string

none

SelectionPath given by the SynchronizationData API

ClassificationID**

string

none

CatalogID given by the CatalogsList API

PartNumber**

string

none

Part Number as it is exactly written in the TraceParts database

CurrentStepNumber

integer

none

Returns the parameter(s) for a specific configuration step

GroupedSteps

boolean

0

Returns the configuration parameters from all steps

* Both parameters (PartID and SelectionPath) have to be used together. In this case, the couple “ClassificationID” and “PartNumber” is not to use.

** Both parameters (ClassificationID and PartNumber) have to be used together. In this case, the couple “PartID” and “SelectionPath” is not to use.

Example of PartNumberData API

The request below returns all items related to a part number as a Json file, with an English content, for the part number 25F of the PNEUMADYNE catalog.

http://ws.tracepartsonline.net/tpowebservices/PartNumberData?UserEmail=test@test.com&PartID=10-09032012-084410&SelectionPath=5|5|5|5|&Language=en&CADFormatId=2&format=json&ApiKey={ApiKey}

PartNumberData responses

PartNumberData responses are returned in the format indicated by the Format parameter within the URL request’s path.

PartNumberData response elements

PartNumberData responses always have the following sequence of answers:

 

Global information (GlobalInfo)

Part Number information (PartInfo)

Product information related to the configuration of the current part number.

  • Version gives the TraceParts version of the product. This version is updated as soon as a change is done in the product data.
  • UpdateDate gives the last updated date of the product, in US format.
  • TitlePart is the label of the product.
  • Description is a short explanation of the product.
  • PartPictureUrl is the URL to the biggest thumbnail available on the TraceParts database. The maximum height is 340 pixels and the maximum width is 460 pixels.
  • LongDescription is an long explanation of the product. Depending on the parameter “HtmlFormat”, it can contain some html markup.
  • NbStep is the total number of configuration steps.
  • CurrentStep is the number of the current step in the configuration process.
  • ManufacturerID is the TraceParts ID for the supplier. It is 33 characters maximum (A through Z, 0 through 9 and – and _ ).
  • ManufacturerName is the label of the catalog, depending on the language.
  • ManufacturerPictureUrl is the URL of the bigger supplier logo on the TraceParts database. The height is 40 pixels and the maximum width is 316 pixels.
  • SelectionPath is a sequence of parameters which defines a unique configuration for one given product.
  • DedicatedDocument is true when there is no available CAD model.
  • Viewer3DPath is the path to the CAD file used for the 3D viewer (displayed if ActivePreview = 1 and if CAD format ID is available).
  • Viewer3DIsAvailable is “True” if a 3D preview can be requested for this configuration.

Supplier information (ManufacturerInfo)

Contact information related to the supplier of the current part number.

  • Description is about the supplier.
  • Address is the supplier’s postal address, formatted with html balises, as requested by the supplier.
  • Emails is the contact email address.
  • WebSites is the supplier’s web site.
  • WebSitesUrl is the url to the supplier’s web site.

Configuration warnings (ConfigurationErrors)

If you build your own configurator, this element reports all errors and offers an optional message with the way to fix it.

 

Dimensional drawings (TechnicalDocumentList)

Provides the list of dimensional drawings related to the current part number.

  • Title is the label of the document.
  • Type is the kind of document (gif, jpeg, pdf…).
  • Url is the URL to the document.

Documents (DocumentList)

Provides the list of documents related to the current part number.

  • Title is the label of the document.
  • Type is the kind of document (gif, jpeg, pdf…).
  • Url is the URL to the document.

Bill Of Materials (BomFields)

Provides the bill of materials related to the current part number.

  • Label is the label of the BOM attribute.
  • Symbol is the ID of the BOM attribute.
  • Value is the value of the BOM attribute.

Configurator (ConfiguratorList)

Provides the information to build a configurator related to the current part number.

  • The first element is named by the type of configurator: “Table” or “Grid“. Depending on the display chose by the supplier, the element will be different.

The first element = Table

FieldTableList provides the collection of valuesFieldTable for each row.

  • The first valuesFieldTable lists the title of each column (the “Selector” column is the ID of the row and must be hidden).
  • The next valuesFieldTable list the values for each column, from the first row until the last one. The sorting is the default one, chosen by the supplier of the catalog.

StepInfo provides the informations related to the current configuration.

  • ConfiguratorType gives the type of configurator of the current configuration.
  • CurrentStep gives the current step of configuration between the number of steps given by NbStep.
  • Selector gives the current valuesFieldTable selected, by using the “Selector” value.

The first element = Grid

FieldGridList provides the collection of ValuesFieldGrid, label, symbol and type for each drop list.

  • Label gives the label of the drop list.
  • Symbol is the ID of the parameter for the current product.
  • Type gives the building of each line. The building definition could have four values (eFormatTypeText | eFormatTypeInteger | eFormatTypeReal | eFormatTypeBox).
  • ValuesFieldGrid gives the informations for each values. See below the informations depending on the Type.
    • eFormatTypeBox:
      • Index is the index sort order of the list.
      • Value is the internal value of the line. It is sent to the configurator via the URL, UTF-8 encoded: URL + “&Grid=1” + “&CB_” + symbol + “=” + value.
      • Label gives the label of the value to display.
      • Selected is set to “selected” when the current configuration, given by the SelectionPath, is linked to this choice. If it is not set, then the element is empty.
    • eFormatTypeText:
      • Index is the index sort order of the list.
      • Value is the internal value of the line (no need to send this value thru the URL).
    • eFormatTypeInteger:
      • Index is the index sort order of the list.
      • Value is the internal value of the line. It is sent to the configurator via the URL, UTF-8 encoded: URL + “&Grid=1” + “&CB_” + symbol + “=” + value.
    • eFormatTypeReal:
      • Index is the index sort order of the list.
      • Value is the internal value of the line (no need to send this value thru the URL).
      • HelpLabel is an optional text to display to help the user to select the value.

StepInfo provides the informations related to the current configuration.

  • ConfiguratorType gives the type of configurator of the current configuration.
  • CurrentStep gives the current step of configuration between the number of steps given by NbStep.

Configuration without CAD file available (SelectorListWithoutCAD)

Gives the list of the configuration which have no CAD file.

  • Index is the index sort order of the list.

Developer support

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

Last updated June 21, 2016