CADFormatsList

List of CAD formats

Introduction

The list of CAD formats depends on options and new formats that TraceParts often adds.

API Key

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

Description

The API returns the “TraceParts CAD format ID” and the label of this CAD format, written in the requested LanguageID.

Building a URL

The CADFormatsList API request takes the following form:

https://ws.tracepartsonline.net/tpowebservices/CADFormatsList?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
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
SelectionPath*stringnoneSelectionPath given by the SynchronizationData API
httpsboolean0URL returned in the answer will use the https protocol

*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 CADFormatsList API

The request below returns all CAD formats as an xml file, with an English label.

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

By changing the Format and adding the ActiveJsonLight, CADFormatsList returns all CAD formats as a light Json file.

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

PartID and SelectionPath:

https://ws.tracepartsonline.net/tpowebservices/CADFormatsList?Language=en&PartID=10-29042015-067703&SelectionPath=1|1|&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}&Version=2

PartNumber and ClassificationID:

https://ws.tracepartsonline.net/tpowebservices/CADFormatsList?Language=en&PartNumber=43900011&ClassificationID=ASCO_JOUCOMATIC&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}&Version=2

CADFormatsList responses

CADFormatsList 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 CAD formats.

{
"cadFormatList": [
{
"cadFormatId":"2",
"cadFormatName":"Acis 6.3",
"deliveryMethod":"1"
},
{
"cadFormatId":"11",
"cadFormatName":"AutoCAD (DWG 13) - 2D",
"deliveryMethod":"1"
},
{
"cadFormatId":"36",
"cadFormatName":"AutoCAD (DWG 13) - 3D",
"deliveryMethod":"1"
},
{
"cadFormatId":"12",
"cadFormatName":"DXF 13 - 2D",
"deliveryMethod":"1"
},
{
"cadFormatId":"37",
"cadFormatName":"DXF 13 - 3D",
"deliveryMethod":"1"
}
]
}

XML Output

Same example as above.

<WsCADFormatList>
<CADFormatList>
<WsCADFormat>
<CADFormatId>2</CADFormatId>
<CADFormatName>Acis 6.3</CADFormatName>
<DeliveryMethod>1</DeliveryMethod>
</WsCADFormat>
<WsCADFormat>
<CADFormatId>11</CADFormatId>
<CADFormatName>AutoCAD (DWG 13) - 2D</CADFormatName>
<DeliveryMethod>1</DeliveryMethod>
</WsCADFormat>
<WsCADFormat>
<CADFormatId>36</CADFormatId>
<CADFormatName>AutoCAD (DWG 13) - 3D</CADFormatName>
<DeliveryMethod>1</DeliveryMethod>
</WsCADFormat>
<WsCADFormat>
<CADFormatId>12</CADFormatId>
<CADFormatName>DXF 13 - 2D</CADFormatName>
<DeliveryMethod>1</DeliveryMethod>
</WsCADFormat>
<WsCADFormat>
<CADFormatId>37</CADFormatId>
<CADFormatName>DXF 13 - 3D</CADFormatName>
<DeliveryMethod>1</DeliveryMethod>
</WsCADFormat>
</CADFormatList>
</WsCADFormatList>

CADFormatsList response elements

CADFormatsList responses contain three elements:

  • “cadFormatId”: defined by TraceParts, usable with other APIs.
  • “cadFormatName”: label of the CAD format, written in the current language.
  • “DeliveryMethod”: way of CAD file delivering. 1: URL to the file | 2: URL to a web page for the selection of the file | 3: Command for Fusion 360 to open the file in the CAD software

Developer support

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

Last updated October 26, 2017