CADDownloadedReport
Report for the CAD files downloaded
New endpoint available: GetLeadsReport
Introduction
This API provides the report which is related to the CAD files downloaded during a period of time.
API Key
This web service requires an API Key. Please use the form to request your API Key.
Description
The API returns an export file, available in a ZIP file, from TraceParts Analytics. Each CAD file delivered through the TraceParts Publishing Network is returned in the file. The information related to the user is directly displayed in the export file. The information which categorizes the user is available with a second web service.
Building a URL
The CADDownloadedReport API request takes the following form:
https://ws.tracepartsonline.net/tpowebservices/CADDownloadedReport?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 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) |
| ExportFormat | string | none | Export file type (xml, json or csv) returned in the zip file |
| DateStart | string | none | Start date on format DD/MM/YYYY |
| DateStop | string | none | Stop date on format DD/MM/YYYY (day excluded in the date range) |
Optional parameters
| Parameter Name | Data type | Default value | Description |
|---|---|---|---|
| ActiveJsonLight | boolean | 0 | Enables the light version when json is the answer file type |
| FilterCountry | ISO 3166 2 characters | none | Filter the export on a list of user country IDs, separated by a semicolon |
| FilterLanguage | string | none | Filter the export on a LanguageID given by the LanguagesList API |
| JobID | string | none | To use for the calls following the first call, to know the status of the request and to access the path to the export file |
| https | boolean | 0 | URL returned in the answer will use the https protocol |
Example of CADDownloadedReport API
The request below returns the information related to the users who downloaded CAD files from Germany or France in June 2016, as a CSV file.
https://ws.tracepartsonline.net/tpowebservices/CADDownloadedReport?DateStart=01/06/2016&DateStop=01/07/2016&format=json&ExportFormat=csv&FilterCountry=DE;FR&ApiKey={ApiKey}&https=1
CADDownloadedReport responses
CADDownloadedReport 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 report ready to download.
{
"JobId":"123",
"State":"COMPLETE"
"FilePath":"https://ws.tracepartsonline.net/Downloads/CADDownloadedReport/CADDownloadedReport123.zip"
}
XML Output
Same example as above.
<WsCADDownloadedReportResult>
<CADDownloadedListResult>
<WsCADDownloadedResult>
<Jobid>123</Jobid>
<State>COMPLETE</State>
<FilePath>https://ws.tracepartsonline.net/Downloads/CADDownloadedReport/CADDownloadedReport123.zip</FilePath>
</WsCADDownloadedResult>
</CADDownloadedListResult>
</WsCADDownloadedReportResult>
CADDownloadedReport response elements
CADDownloadedReport responses contain three elements:
- “JobId”: ID of your request as described before in the list of parameters.
- “State”: “WORKING” when the asynchronous task is running to extract the data. “COMPLETE” when the export is ready and the file is ready to download.
- “FilePath”: path where the export file is stored and ready to be downloaded.
Content of the report
| Field | Data type | Description |
|---|---|---|
| UserEmail | string | User’s email address |
| f_Civility | string | ID of the Civility value. Please use the FormsData web service to collect the list of values. |
| Name | string | User’s last name |
| FirstName | string | User’s first name |
| Company | string | User’s company |
| f_CompanySize | string | ID of the CompanySize value. Please use the FormsData web service to collect the list of values. |
| f_Activity | string | ID of the Activity value. Please use the FormsData web service to collect the list of values. |
| f_Service | string | ID of the Service value. Please use the FormsData web service to collect the list of values. |
| f_Job | string | ID of the Job value. Please use the FormsData web service to collect the list of values. |
| Phone | string | User’s phone number |
| Address1 | string | Field #1 of the user’s postal address |
| Address2 | string | Field #2 of the user’s postal address |
| Address3 | string | Field #3 of the user’s postal address |
| City | string | User’s city |
| ZipCode | string | User’s zip code |
| f_Country | string | User’s country following the ISO 3166 standard |
| f_NAState | string | ID of the NAState (state of North America) value. Please use the FormsData web service to collect the list of values. |
| PartNumber | string | Part number of the downloaded CAD file |
| PartDescription | string | Description of the downloaded CAD file |
| CADFormat | string | CADFormatID given by the CADFormatsList API |
| Language | string | LanguageID given by the LanguagesList API |
| Date | string | CAD file downloaded date |
| Status | string | “downloaded” for the CAD file directly saved from the website. “e-mailed” for the CAD file sent by the TraceParts email server. “inserted” for the CAD file directly inserted in the CAD software. |
| Origin | string | ID of the website of the TraceParts Publishing Network |
| Catalog | string | CatalogID given by the CatalogsList API |
| CatalogName | string | Label of the catalog |
| PartnersMails | string | The value is “no” when the user does not consent to receive information by email from TraceParts’s partners |
Developer support
Please contact us for any problem, question or comment related to this content integration.
Last updated March 14, 2018
Updated 9 months ago