SOAP Documentation: Authentication

Overview

The Athentication resource provides methods to retrieve and expire a Session ID. All API methods, less the Version method in each resource, takes in a Session ID as a parameter. A Session ID is a temporary token used along with a registered Application Key to identify which TraceGains Customer is making an API call and whether the method call should be allowed.

A Session ID will expire automatically based on the configuration of the Application Key that made the request. However, TraceGains recommends that each Session ID be expired by making a call to the method Logout once determined the Session ID is no longer required.


Operations List

The Operations List for this resource: Authentication Operations List.


Resource WSDL

The WSDL for this resource can be found here: Authentication WSDL.


Endpoint URLs

All requests should be sent to one of the following:
      Production Environment: https://api.tracegains.net/v7/soap/Authentication.asmx.
      Test Environment: https://api-test.tracegains.net/v7/soap/Authentication.asmx.


Login

Enterprise | SM SC SPM FM QM

 This method uses an active registered Application Name and Application Key to aquire a new Session ID.


Request:

Parameter Type Description
appName String The Application Name of a registered and active Application Key.
appKey Guid A registered and active Application Key.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP Status Code
Message String A log friendly message.
Authenticated Boolean True if successful, False if failed.
CustomerId Guid The TraceGains Customer ID associated with the Application Key.
SessionId Guid A temporary token that can be used to make additional method calls.
SessionExpires DateTime The date and time, in Coordinated Universal Time (UTC), the SessionId will expire.

Logout

Enterprise | SM SC SPM FM QM

 Logs out, expires, an active Session ID aquired from the Login method.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.

Response:

RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Version

 Reports the version information of this resource.


Request:

No Parameters


Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP Status Code
Message String A log friendly message that can be used in troubleshooting a failed response.
Version String The major, minor, and build number of this resource.