Table of Contents
Description
Returns a valid authentication token in response to submission of a valid usename and password combination. The authentication token is a required input parameter for other methods of the service (refer to our authentication page for more information).
Input Parameters
| Tag name |
Type |
Description |
Required |
| username |
string |
A valid username for an account on the pedstep.org site. The account must have been granted service use privileges by a member of the STEPSTools technical team. Contact them
here. |
yes |
| password |
string |
A valid password for the supplied username. |
yes |
Output Values
The content of the service output depends on whether the username and password are valid or invalid.
Valid Credentials
If all of the following are true:
- the supplied username is for an active account
- the account has been granted privileges to call the service
- the supplied password is correct for that username/account
then the credentials are valid and the following is returned inside an "authTokenEnvelope" node:
| Tag name |
Type |
Description |
| AuthToken |
string |
This is the valid authentication token returned by the service for the calling account. This token can be used as the authToken input parameter for other methods of the service. |
| RequestingUser |
string |
The is the username on the account that the valid token is associated with. |
Invalid Credentials
If any of the following is true:
- the supplied username is not recognized
- the supplied username is for an inactive account
- the account for the supplied username has not been granted privileges to call the service
- the supplied password does not match the supplied username
then the credentials are not valid, and the service will return an array of one or more error messages detailing the exact nature of the error. For explanation of STEPSTools error messaging, please see our
Error Messages documentation.
Example HTTP GET Message
Request
GET http://dev.pedstep.org/Rounding/GetAuthToken.aspx?_
username=johndoe&_
password=johnspsswrd HTTP/1.1
Host: www.pedstep.org
Additional notes:
- Underscores in the above example are not actual characters which should be used in a real web service request. These are included only to indicate continuation of a single line.
- This method works almost exactly the same whether it is being called for the rounding service or compounding service. The only difference is which of the two is specified in the path for the GET call. The return from the method will be the same either way.
Practice Tool