Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET /session

...

The following message will be returned when the request succeeds.  Once the token is generated, the following URL can be used to sign on to Club OS: https://www.club-os.com/action/Login/token-login?token=[token] 

ValueMessage
<token>

UserId: <userId> found. Use token to login.

Failure Response

If your request fails, you will receive a Response object containing the following:

PropertyTypeDescription
statusBooleanWill always be false.
responsesResponseMessage[]An array of ResponseMessage objects describing the error.

New Functionality as of 8/14/2015.

A URL can also be generated which will redirect to the desired page. In the example below the redirect is encoded with javascript: encodeURIComponent('/action/Calendar').

https://www.club-os.com/action/Login/token-login?token=[token]&redirect=%2Faction%2FCalendar

This can also be combined with user delegation and redirect: In the example below the second redirect is doubly encoded. encodeURIComponent('/action/Delegate/[delegateUserId]?redirect=' + encodeURIComponent('/action/Calendar'))

https://www.club-os.com/action/Login/token-login?token=[token]&redirect=%2Faction%2FDelegate%2F[delegateUserId]%3Fredirect%3D%252Faction%252FCalendar