POST Account/LoginUser

Login for the user.

Request Information

URI Parameters

None.

Body Parameters

ApiLoginRequest
NameDescriptionTypeAdditional information
username

Gets or sets the username.

 string

None.
password

Gets or sets the password.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "username": "sample string 1",
  "password": "sample string 2"
}

application/xml, text/xml

Sample: 
<ApiLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <password>sample string 2</password>
  <username>sample string 1</username>
</ApiLoginRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ApiLoginRequest'.

Response Information

Resource Description

LogonResponseLite.

ApiLoginResponse
NameDescriptionTypeAdditional information
ResponseObject

Gets or sets the response object.

 ApiUser

None.
SessionToken

Gets or sets the session token.

 string

None.
ResponseType

Gets or sets the type of the response.

 integer

None.
ResponseMessage

Gets or sets the response message.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseObject": {
    "UserID": 1,
    "UserGuid": "cca7b504-5fdd-4466-a461-d68b6ab2c7dd",
    "UserName": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "ChangePassword": true,
    "LastPasswordChange": "2025-12-27T08:56:32.8902513+02:00",
    "Enabled": true,
    "FailedLogins": 8,
    "EmailAddress": "sample string 9",
    "IdentityTypeValue": "sample string 10",
    "FK_IdentityTypeID": 1,
    "GBLicense": "sample string 11",
    "FK_CompanyID": 1,
    "MessagingToken": "sample string 12",
    "FK_HoldingCompanyID": 64,
    "FK_RoleID": 1,
    "FK_BranchID": 1,
    "IsInPlayChecked": true
  },
  "SessionToken": "sample string 1",
  "ResponseType": 2,
  "ResponseMessage": "sample string 3"
}

application/xml, text/xml

Sample: 
<ApiLoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <ResponseMessage>sample string 3</ResponseMessage>
  <ResponseType>2</ResponseType>
  <ResponseObject>
    <ChangePassword>true</ChangePassword>
    <EmailAddress>sample string 9</EmailAddress>
    <Enabled>true</Enabled>
    <FK_BranchID>1</FK_BranchID>
    <FK_CompanyID>1</FK_CompanyID>
    <FK_HoldingCompanyID>64</FK_HoldingCompanyID>
    <FK_IdentityTypeID>1</FK_IdentityTypeID>
    <FK_RoleID>1</FK_RoleID>
    <FailedLogins>8</FailedLogins>
    <FirstName>sample string 4</FirstName>
    <GBLicense>sample string 11</GBLicense>
    <IdentityTypeValue>sample string 10</IdentityTypeValue>
    <IsInPlayChecked>true</IsInPlayChecked>
    <LastName>sample string 5</LastName>
    <LastPasswordChange>2025-12-27T08:56:32.8902513+02:00</LastPasswordChange>
    <MessagingToken>sample string 12</MessagingToken>
    <UserGuid>cca7b504-5fdd-4466-a461-d68b6ab2c7dd</UserGuid>
    <UserID>1</UserID>
    <UserName>sample string 3</UserName>
  </ResponseObject>
  <SessionToken>sample string 1</SessionToken>
</ApiLoginResponse>