POST api/Account/Login
Method to log in a user
Request Information
URI Parameters
None.
Body Parameters
LoginViewModel
LoginViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Username | string |
Required Matching regular expression pattern: (?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\]) |
|
| Password | string |
Required |
|
| RememberMe | boolean |
None. |
|
| CurrentLoginGuid | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Password": "sample string 2",
"RememberMe": true,
"CurrentLoginGuid": "763694fc-8857-4647-a754-acc55475b676"
}
application/xml, text/xml
Sample:
<LoginViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSAeReader.Common.ViewModels"> <CurrentLoginGuid>763694fc-8857-4647-a754-acc55475b676</CurrentLoginGuid> <Password>sample string 2</Password> <RememberMe>true</RememberMe> <Username>sample string 1</Username> </LoginViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResult[TokenModel] with the Access Token
ApiResultOfTokenModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors | ErrorModel |
None. |
|
| Result | TokenModel |
None. |
|
| IsSuccess | boolean |
None. |
|
| StatusCode | HttpStatusCode |
None. |
Response Formats
application/json, text/json
Sample:
{
"Errors": {
"ErrorsNumber": 1,
"Messages": [
"sample string 1",
"sample string 2"
],
"MessagesString": "sample string 2"
},
"Result": {
"userId": 1,
"access_token": "sample string 2",
"token_type": "sample string 3",
"expires_in": 4,
"userName": "sample string 5",
"givenName": "sample string 6",
"surName": "sample string 7",
".issued": "2025-12-15T13:08:26.9180307-05:00",
".expires": "2025-12-15T13:08:26.9180307-05:00",
"error_description": "sample string 10",
"ServerDateTime": "2025-12-15T13:08:26.9180307-05:00"
},
"IsSuccess": false,
"StatusCode": 100
}
application/xml, text/xml
Sample:
<ApiResultOfTokenModel5MESSB3T xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSAeReader.Common.API">
<Errors>
<ErrorsNumber>1</ErrorsNumber>
<Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</Messages>
<MessagesString>sample string 2</MessagesString>
</Errors>
<Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/CSAeReader.Common.Models">
<d2p1:AccessToken>sample string 2</d2p1:AccessToken>
<d2p1:ErrorDescription>sample string 10</d2p1:ErrorDescription>
<d2p1:Expires>2025-12-15T13:08:26.9180307-05:00</d2p1:Expires>
<d2p1:GivenName>sample string 6</d2p1:GivenName>
<d2p1:Issued>2025-12-15T13:08:26.9180307-05:00</d2p1:Issued>
<d2p1:ServerDateTime>2025-12-15T13:08:26.9180307-05:00</d2p1:ServerDateTime>
<d2p1:SurName>sample string 7</d2p1:SurName>
<d2p1:TokenType>sample string 3</d2p1:TokenType>
<d2p1:UserId>1</d2p1:UserId>
<d2p1:UserName>sample string 5</d2p1:UserName>
<d2p1:expires_in>4</d2p1:expires_in>
</Result>
<StatusCode>Continue</StatusCode>
</ApiResultOfTokenModel5MESSB3T>