CheckLogin
Check the existence of a user account
New endpoint available: CheckLogin
Introduction
This API allows you to check if a user account already exists in the TraceParts database. This check could help you to reduce the number of calls to the UserRegistration API.
API Key
This web service requires an API Key. Please use the form to request your API Key.
Description
The API returns the existence of the user email in the TraceParts database.
Building a URL
The CheckLogin API request takes the following form:
https://ws.tracepartsonline.net/tpowebservices/CheckLogin?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) |
UserEmail | string | none | User email / User ID |
Optional parameters
Parameter Name | Data type | Default value |
---|---|---|
ActiveJsonLight | boolean | 0 |
Example of CheckLogin API
The request below returns the existence of a user account with the email as an xml file.
https://ws.tracepartsonline.net/tpowebservices/CheckLogin?UserEmail=test@traceparts.com&Format=xml&ApiKey={ApiKey}
By changing the Format and adding the ActiveJsonLight, CheckLogin returns the existence as a light Json file.
https://ws.tracepartsonline.net/tpowebservices/CheckLogin?UserEmail=test@traceparts.com&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}
CheckLogin responses
CheckLogin 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.
<WsCheckLogin>
<Registered>true</Registered>
</WsCheckLogin>
CheckLogin response elements
CheckLogin responses contain one element:
- “Registered”: the value is “true” or “false” if the user account already exists in the TraceParts database or not.
Developer support
Please contact us for any problem, question or comment related to this content integration.
Last updated January 28, 2016
Updated 25 days ago