CADemail

Email a CAD file

Introduction

This API provides a CAD file (or several, depending on the CAD format and the type of product) by email.

API Key

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

Description

The API returns if the zip file has been sent to the email address provided by the web service. The zip file contains one or several CAD files, depending on the configuration.

Building a URL

The CADemail API request takes the following form:

https://ws.tracepartsonline.net/tpowebservices/CADemail?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
UserEmailstringnoneUser email / User ID
FormatstringnoneAnswer file type (xml, json or csv)
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
CADFormatIDintegernoneCADFormatID given by the CADFormatsList API

Optional parameters

Parameter NameData typeDefault valueDescription
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 CADemail API

The request below returns the status of the sending by email of the CAD files for the part number 43900011 from the catalog ASCO Numatics in Autodesk Inventor CAD format.

PartID and SelectionPath:

https://ws.tracepartsonline.net/tpowebservices/[email protected]&PartID=10-17102002-114249&SelectionPath=1|1|1|1|&CADFormatId=9&Language=en&Format=xml&ApiKey={ApiKey}

PartNumber and ClassificationID:

https://ws.tracepartsonline.net/tpowebservices/[email protected]&PartNumber=43900011&ClassificationID=ASCO_JOUCOMATIC&CADFormatId=9&Language=en&Format=xml&ApiKey={ApiKey}

By changing the Format and adding the ActiveJsonLight, CADemail returns the status of the request as a light Json file:

https://ws.tracepartsonline.net/tpowebservices/[email protected]&PartID=10-17102002-114249&SelectionPath=1|1|1|1|&CADFormatId=9&Language=en&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}

CADemail responses

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

JSON Output

The HTTP request is shown below, displaying the status of the sending by email.

{
"send":true
}

XML Output

Same example as above.

<WsCADemail>
<Send>true</Send>
</WsCADemail>

CADemail response elements

The CADemail responses contain one single element:

  • “send”: “true” if the zip files containing the CAD files, has been sent. “false” is the CAD files cannot be sent.

Developer support

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

Last updated July 6, 2015