Authenticate Response

Content Type

application/json

HTTP Headers

NONE

HTTP Status Code

200, 400, or 401

Please use the 401 HTTP status code to indicate the failure of the HTTP Basic authentication Gateway uses to identify itself and let the json body returned indicate the success or failure of the student credentials we sent with the request.

Response Fields

result

expected values:

• VALID
  The username and password are valid
• INVALID
  The username and password are NOT valid
• EXCEPTION
  Something is broke or borked
  
  

tp_user_id

The tool provider's user id of the user that was validated.

Example (valid username and password):

HTTP Status Code: 200
RESPONSE:
 - BODY:
    {
        "result": "VALID",
        "tp_user_id": "2323-12232-222"
    }

Example (invalid username and password):

HTTP Status Code: 200
RESPONSE:
 - BODY:
    {
        "result": "INVALID"
    }