CADDataAvailability

CAD data availability

📘

New endpoint available: CadDataAvailability

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 use the form 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:

https://ws.tracepartsonline.net/tpowebservices/CADdataAvailability?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)
PartID*stringnonePartID given by the SynchronizationData API
ClassificationID**stringnoneClassificationId given by the CatalogsList API
PartNumber**stringnonePart Number as it is exactly written in the TraceParts database
LanguagestringenLanguageID given by the LanguagesList API

Optional parameters

Parameter NameData typeDefault valueDescription
UserEmailstringnoneUser email / User ID
ActiveJsonLightboolean0Enables the light version when json is the answer file type
SelectionPath*stringnoneSelectionPath given by the SynchronizationData API

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

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

PartNumber and ClassificationID:

https://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.

https://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 problem, question or comment related to this content integration.

Last updated January 28, 2016