API/UserPortal/CreateSession

Purpose

The Create Session method will allow you to create a tokenised session to simplify login process into the user portal. By creating a token and redirecting in, you don't have to have a client check in twice.

Inputs

 <soapenv:Header/>
  <soapenv:Body>
     <user:CreateSessionRequest>
        <username>username@domain.com.au</username>
        <password>abc123</password>
     </user:CreateSessionRequest>
  </soapenv:Body>

Output

 <SOAP-ENV:Body>
     <ns1:CreateSessionResponse>
        <session>8dd43e08096399e7615dc4866830aafb5ecf843010dec1c37720de4554bf4f62</session>
     </ns1:CreateSessionResponse>
  </SOAP-ENV:Body>

Further notes / usage

The method will return you a login key. This login key can be used to redirect a client directly to the userportal and log them in with their validated account. The syntax for this post call is:

https://portal.your-domain.com/?login=<sessionkey>

Where ‘sessionkey’ is the return value of the API call above. This post call will automatically log in the validated user with this session key and redirect them to the main menu of the userportal.

Error String

173. Invalid username

174. Invalid password for username supplied