UserRegistration

Creation of a user account

Introduction

This API allows you to create a TraceParts user account with few required user informations.

API Key

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

Description

The API returns the success of the registration process.

Building a URL

The UserRegistration API request takes the following form:

https://ws.tracepartsonline.net/tpowebservices/UserRegistration?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 valueDescriptionLength minLength max
ApiKeystringnoneCode calling an API to track and control how the API is usedN/AN/A
FormatstringnoneAnswer file type (xml, json or csv)N/AN/A
UserEmailstringnoneUser email / User ID5100
companystringnoneUser company250
countryISO 3166 2 charactersnoneUser country22

Optional parameters

Parameter NameData typeDefault valueDescriptionLength minLength max
ActiveJsonLightboolean0Enables the light version when json is the answer file typeN/AN/A
namestringnoneUser last name250
fnamestringnoneUser first name250
addr1stringnoneFirst field for the user address280
addr2stringnoneSecond field for the user address280
addr3stringnoneThird field for the user address280
citystringnoneUser city250
statestringnoneUser state, for North America280
zipcodestringnoneUser ZIP code320
phonestringnoneUser phone number525
faxstringnoneUser FAX number520
TPOptInboolean0Consent to receive information sent by TraceParts by email about TraceParts servicesN/AN/A
PartnersOptInboolean0Consent to receive information sent by TraceParts by email about TraceParts’ partners’ servicesN/AN/A

Example of UserRegistration API

The request below creates a user account and returns the success of the registration as an xml file.

https://ws.tracepartsonline.net/tpowebservices/[email protected]&Company=TraceParts&Country=US&Format=xml&ApiKey={ApiKey}

By changing the Format and adding the ActiveJsonLight, UserRegistration returns the registration success as a light Json file.

https://ws.tracepartsonline.net/tpowebservices/[email protected]&Company=TraceParts&Country=US&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}

UserRegistration responses

UserRegistration 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 if the user account exists.

{
"registered":true
}

XML Output

Same example as above.

<WsUserRegistration>
<Registered>true</Registered>
</WsUserRegistration>

UserRegistration response elements

UserRegistration responses contain one element:

  • “Registered”: the value is “true” or “false” if the user account creation succeeded or not.

Developer support

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

Last updated July 25, 2016