webleads-tracker

Home > TraceParts for Developers > Availability of the CAD data

Introduction

The CADdataAvailability provides you with the list of CAD data. For the couple catalog/part number provided, you can know if it is available, if a 3D view can be requested, and which CAD formats can be downloaded.

 

API Key

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

 

Description

The API returns if the part number exists on TraceParts. In this case, will be returned the 3D viewer capability and the list of CADformatID with their labels.

 

Building a URL

The CADdataAvailability API request takes the following form:

http://ws.tracepartsonline.net/tpowebservices/CADdataAvailability?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

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

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

* 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.

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 CADdataAvailability API

The request below returns the CAD data availability as an xml file for the part number 43900011 from the catalog ASCO Numatics.
PartID and SelectionPath:

http://ws.tracepartsonline.net/tpowebservices/CADdataAvailability?PartID=10-17102002-114249&SelectionPath=1|1|1|1|&Language=en&Format=xml&ApiKey={ApiKey}

PartNumber and ClassificationID:

http://ws.tracepartsonline.net/tpowebservices/CADdataAvailability?PartNumber=43900011&ClassificationID=ASCO_JOUCOMATIC&Language=en&Format=xml&ApiKey={ApiKey}

By changing the Format and adding the ActiveJsonLight, CADdataAvailability returns the availability as a light Json file.

http://ws.tracepartsonline.net/tpowebservices/CADdataAvailability?PartID=10-17102002-114249&SelectionPath=1|1|1|1|&Language=en&Format=json&Asynchronous=1&ApiKey={ApiKey}

CADdataAvailability responses

CADdataAvailability 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 a sample of the available CAD formats, the Part Number and 3D viewer availabilities.

{
"partNumberAvailability":
{
"partNumber":"43900011",
"availability":true
},
"viewerAvailability":true,
"cadFormatList":
[{
"cadFormatId":33,
"cadFormatName":"3D XML"
},
{
"cadFormatId":2,
"cadFormatName":"Acis 6.3"
},
{
"cadFormatId":11,
"cadFormatName":"AutoCAD (DWG 13) - 2D"
},
{
"cadFormatId":48,
"cadFormatName":"ZW3D"
}]
}

 

XML Output

Same example as above.

<WsCADdataAvailability>
<CADFormatList>
<WsCADFormat>
<CADFormatId>33</CADFormatId>
<CADFormatName>3D XML</CADFormatName>
</WsCADFormat>
<WsCADFormat>
<CADFormatId>2</CADFormatId>
<CADFormatName>Acis 6.3</CADFormatName>
</WsCADFormat>
<WsCADFormat>
<CADFormatId>11</CADFormatId>
<CADFormatName>AutoCAD (DWG 13) - 2D</CADFormatName>
</WsCADFormat>
<WsCADFormat>
<CADFormatId>48</CADFormatId>
<CADFormatName>ZW3D</CADFormatName>
</WsCADFormat>
</CADFormatList>
<PartNumberAvailability>
<Availability>true</Availability>
<PartNumber>43900011</PartNumber>
</PartNumberAvailability>
<ViewerAvailability>true</ViewerAvailability>
</WsCADdataAvailability>

CADdataAvailability response elements

CADdataAvailability responses contain five elements:

  • “PartNumber”: part number without any special characters, ignored by TraceParts for the search feature (” “,”-“,”.”,”/”,”+”).
  • “Availability”: true or false if the PartNumber is available or not on the TraceParts database.
  • “ViewerAvailability”: true or false if you can use the 3D viewer API.
  • “CADFormatId”: defined by TraceParts, usable with other APIs.
  • “CADFormatName”: label of the CAD format, written in the current language.

Developer support

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

Last updated January 28, 2016