POST api/student/login

Returns an access token to be used for "auto-login" in other services, e.g. the Hub. The access token expires after some time so it's important to request a new access token for each login attempt.

Request Information

URI Parameters

None.

Body Parameters

An object which includes a Poseidon customer ID

AccessTokenRequest
NameDescriptionTypeAdditional information
PoseidonBookingId

The Poseidon Booking Id for a student.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "poseidonBookingId": "sample string 1"
}

application/xml, text/xml

Sample: 
<AccessTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <PoseidonBookingId>sample string 1</PoseidonBookingId>
</AccessTokenRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A fresh access token and it's expiration date

AccessTokenResponse
NameDescriptionTypeAdditional information
AccessToken

The users access token.

 string

None.
ExpiresOn

The expiration date for the access token.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "accessToken": "sample string 1",
  "expiresOn": "2025-12-19T12:03:26.0766025Z"
}

application/xml, text/xml

Sample: 
<AccessTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HSEY.API.Models.Student">
  <AccessToken>sample string 1</AccessToken>
  <ExpiresOn>2025-12-19T12:03:26.0766025+00:00</ExpiresOn>
</AccessTokenResponse>