SupplierContacts
Introduction
The contacts of the catalog are based on the information provided by the supplier of the data. It may include basic information such as the simple website of the contact up to very detailed information such as postal addresses, email addresses and so forth.
New version
API Key
This web service requires an API Key. Please refer to this chapter to request your API Key.
Description
The API returns contact information for one given catalog.
Building a URL
The SupplierContacts API request takes the following form:
http://ws.tracepartsonline.net/tpowebservices/SupplierContacts?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) |
ClassificationID |
string |
none |
CatalogID given by the CatalogsList 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 |
Example of SupplierContacts API
The request below returns all contacts for the ASCO Numatics catalog as an xml file.
http://ws.tracepartsonline.net/tpowebservices/SupplierContacts?UserEmail=test@test.com&ClassificationId=ASCO_JOUCOMATIC&Format=xml&ApiKey={ApiKey}
By changing the Format and adding the ActiveJsonLight, SupplierContacts returns all contacts as a light Json file.
http://ws.tracepartsonline.net/tpowebservices/SupplierContacts?UserEmail=test@test.com&ClassificationId=ASCO_JOUCOMATIC&ActiveJsonLight=1&Format=json&ApiKey={ApiKey}
SupplierContacts responses
SupplierContacts 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 contacts.
{ "classificationId":"ASCO_JOUCOMATIC", "supplierName":"ASCO Numatics" "supplierAddress":"ASCO Numatics (ASCO JOUCOMATIC SA)<br/>Avenue Albert 1er<br/>BP 312<br/>92506<br/>RUEIL MALMAISON Cedex<br/&>FRANCE" "supplierEmail":"Webmaster.asconumatics.fr@emerson.com", "supplierWebSite":"www.asconumatics.fr", "supplierAddressFieldCompany":"ASCO Numatics (ASCO JOUCOMATIC SA)", "supplierAddressFieldAddress1":"32 Avenue Albert 1er", "supplierAddressFieldAddress2":"BP 312", "supplierAddressFieldAddress3":"", "supplierAddressFieldZipCode":"92506", "supplierAddressFieldCity":"RUEIL MALMAISON Cedex", "supplierAddressFieldCountry":"FRANCE", "supplierAddressFieldProvince":"", "supplierAddressFieldISOCountryCode":"FR", "phones":"(33) 1 47 14 32 00", "fax":"(33) 1 47 08 53 85", }, { "classificationId":"ASCO_JOUCOMATIC", "supplierName":"ASCO Numatics" "supplierAddress":"ASCO Numatics (ASCO JOUCOMATIC Ltd)<br/>2 Pit Hey Place<br/>West Pimbo<br/>SKELMERSDALE<br/>WN89PG<br/>Lancashire<br/>ENGLAND" "supplierEmail":"Webmaster.asconumatics.fr@emerson.com", "supplierWebSite":"www.asconumatics.eu", "supplierAddressFieldCompany":"ASCO Numatics (ASCO JOUCOMATIC Ltd)", "supplierAddressFieldAddress1":"2 Pit Hey Place", "supplierAddressFieldAddress2":"West Pimbo", "supplierAddressFieldAddress3":"SKELMERSDALE", "supplierAddressFieldZipCode":"WN89PG", "supplierAddressFieldCity":"Lancashire", "supplierAddressFieldCountry":"ENGLAND", "supplierAddressFieldProvince":"", "supplierAddressFieldISOCountryCode":"GB", "phones":"(44) 1 / 695.713 600", "fax":"(44) 1 / 695.713 633", }
XML Output
Same example as above.
<WsSupplierContacts> <ClassificationId>ASCO_JOUCOMATIC</ClassificationId> <Fax>(33) 1 47 08 53 85</Fax> <Phones>(33) 1 47 14 32 00</Phones> <SupplierAddress>ASCO Numatics (ASCO JOUCOMATIC SA)<br/>Avenue Albert 1er<br/>BP 312<br/>92506<br/>RUEIL MALMAISON Cedex<br/&>FRANCE</SupplierAddress> <SupplierAddressFieldAddress1>32 Avenue Albert 1er</SupplierAddressFieldAddress1> <SupplierAddressFieldAddress2>BP 312</SupplierAddressFieldAddress2> <SupplierAddressFieldAddress3/> <SupplierAddressFieldCity>RUEIL MALMAISON Cedex</SupplierAddressFieldCity> <SupplierAddressFieldCompany>ASCO Numatics (ASCO JOUCOMATIC SA)</SupplierAddressFieldCompany> <SupplierAddressFieldCountry>FRANCE</SupplierAddressFieldCountry> <SupplierAddressFieldISOCountryCode>FR</SupplierAddressFieldISOCountryCode> <SupplierAddressFieldProvince/> <SupplierAddressFieldZipCode>92506</SupplierAddressFieldZipCode> <SupplierEmail>Webmaster.asconumatics.fr@emerson.com</SupplierEmail> <SupplierName>ASCO Numatics</SupplierName> <SupplierWebSite>www.asconumatics.fr</SupplierWebSite> </WsSupplierContacts> <WsSupplierContacts> <ClassificationId>ASCO_JOUCOMATIC</ClassificationId> <Fax>(44) 1 / 695.713 633</Fax> <Phones>(44) 1 / 695.713 600</Phones> <SupplierAddress>ASCO Numatics (ASCO JOUCOMATIC Ltd)<br/>2 Pit Hey Place<br/>West Pimbo<br/>SKELMERSDALE<br/>WN89PG<br/>Lancashire<br/>ENGLAND</SupplierAddress> <SupplierAddressFieldAddress1>2 Pit Hey Place</SupplierAddressFieldAddress1> <SupplierAddressFieldAddress2>West Pimbo</SupplierAddressFieldAddress2> <SupplierAddressFieldAddress3>SKELMERSDALE</SupplierAddressFieldAddress3> <SupplierAddressFieldCity>Lancashire</SupplierAddressFieldCity> <SupplierAddressFieldCompany>ASCO Numatics (ASCO JOUCOMATIC Ltd)</SupplierAddressFieldCompany> <SupplierAddressFieldCountry>ENGLAND</SupplierAddressFieldCountry> <SupplierAddressFieldISOCountryCode>GB</SupplierAddressFieldISOCountryCode> <SupplierAddressFieldProvince/> <SupplierAddressFieldZipCode>WN89PG</SupplierAddressFieldZipCode> <SupplierEmail>Webmaster.asconumatics.fr@emerson.com</SupplierEmail> <SupplierName>ASCO Numatics</SupplierName> <SupplierWebSite>www.asconumatics.eu</SupplierWebSite> </WsSupplierContacts>
SupplierContacts response elements
SupplierContacts responses contain sixteen elements:
- “ClassificationId”: TraceParts ID for the catalog. It is 33 characters maximum (A through Z, 0 through 9 and – and _ )
- “SupplierAddress”: postal address with all fields concatenated
- “SupplierAddressFieldAddress1”: field #1 of the postal address
- “SupplierAddressFieldAddress2”: Field #2 of the postal address
- “SupplierAddressFieldAddress3”: field #3 of the postal address
- “SupplierAddressFieldCity”: city of the postal address
- “SupplierAddressFieldCompany”: company name of the postal address
- “SupplierAddressFieldCountry”: country of the postal address
- “SupplierAddressFieldZipCode”: ZIP code of the postal address
- “SupplierAddressFieldProvince”: province of the postal address (e.g.: the state for the USA)
- “SupplierAddressFieldISOCountryCode”: ISO code of the country
- “Phones”: phone number
- “Fax”: fax number
- “SupplierEmail”: Email address
- “SupplierName”: Label of the catalog
- “SupplierWebSite”: Website
Developer support
Please contact us for any problems, questions or comments related to this web service.
Last updated October 20, 2015