webleads-tracker

Home > TraceParts for Developers > 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 refer to this chapter 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:

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

 

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

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

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

Example of CADFormatsList API

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

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

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

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

PartID and SelectionPath:

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

PartNumber and ClassificationID:

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

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.

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

 

XML Output

Same example as above.

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

CADFormatsList response elements

CADFormatsList responses contain two elements:

  • “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 June 26, 2015