GET api/Login/Login?username={username}&password={password}&administration={administration}

Request a logintoken for the specified user and password

Request Information

URI Parameters

Name	Type	Additional information
username	string	Required
password	string	Required
administration	integer	Required

Body Parameters

None.

Response Information

Resource Description

LoginResponse

Name	Type	Additional information
Token	globally unique identifier	None.
ValidUntil	date	None.
HasNoEmailAddress	boolean	None.
Status	CompleteEmailStatus	None.
StatusNumber	integer	None.
ErrorCode	ErrorCode	None.
ErrorNumber	integer	None.
ErrorDescription	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Token": "51f0cce2-d839-4fcf-a925-10c6f206a591",
  "ValidUntil": "2026-01-20T13:49:20.1400177+01:00",
  "HasNoEmailAddress": true,
  "Status": 0,
  "StatusNumber": 4,
  "ErrorCode": 0,
  "ErrorNumber": 1,
  "ErrorDescription": "sample string 5"
}

application/xml, text/xml

Sample:

<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hevo.App.WebAPI.Models">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Hevo.Core.Datalayer.Models">Global_Exception</ErrorCode>
  <ErrorDescription xmlns="http://schemas.datacontract.org/2004/07/Hevo.Core.Datalayer.Models">sample string 5</ErrorDescription>
  <ErrorNumber xmlns="http://schemas.datacontract.org/2004/07/Hevo.Core.Datalayer.Models">1</ErrorNumber>
  <HasNoEmailAddress>true</HasNoEmailAddress>
  <Status>Unknown</Status>
  <StatusNumber>4</StatusNumber>
  <Token>51f0cce2-d839-4fcf-a925-10c6f206a591</Token>
  <ValidUntil>2026-01-20T13:49:20.1400177+01:00</ValidUntil>
</LoginResponse>