UserRegistration
Creation of a user account
New endpoint available: SignUp
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 Name | Data type | Default value | Description | Length min | Length max |
---|---|---|---|---|---|
ApiKey | string | none | Code calling an API to track and control how the API is used | N/A | N/A |
Format | string | none | Answer file type (xml, json) | N/A | N/A |
UserEmail | string | none | User email / User ID | 5 | 100 |
company | string | none | User company | 2 | 50 |
country | ISO 3166 2 characters | none | User country | 2 | 2 |
Optional parameters
Parameter Name | Data type | Default value | Description | Length min | Length max |
---|---|---|---|---|---|
ActiveJsonLight | boolean | 0 | Enables the light version when json is the answer file type | N/A | N/A |
name | string | none | User last name | 2 | 50 |
fname | string | none | User first name | 2 | 50 |
addr1 | string | none | First field for the user address | 2 | 80 |
addr2 | string | none | Second field for the user address | 2 | 80 |
addr3 | string | none | Third field for the user address | 2 | 80 |
city | string | none | User city | 2 | 50 |
state | string | none | User state, for North America only | 2 | 10 |
zipcode | string | none | User ZIP code | 3 | 20 |
phone | string | none | User phone number | 5 | 25 |
fax | string | none | User FAX number | 5 | 20 |
TPOptIn | boolean | 0 | Consent to receive information sent by TraceParts by email about TraceParts services | N/A | N/A |
PartnersOptIn | boolean | 0 | Consent to receive information sent by TraceParts by email about TraceParts’ partners’ services | N/A | N/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 problem, question or comment related to this content integration.
Last updated July 25, 2016
Updated 9 months ago