POST api/Account/Login

Request Information

URI Parameters

None.

Body Parameters

TaskyamWebAPI.Models.Account.LoginModel

Name	Type	Additional information
UserName	string	Required Data type: Text
Password	string	Required Data type: Password
LoginRedirectID	integer	None.
SiteMapName	string	None.
LanguageName	string	None.
isLoginAzure	boolean	None.
AppID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "LoginRedirectID": 1,
  "SiteMapName": "sample string 3",
  "LanguageName": "sample string 4",
  "isLoginAzure": true,
  "AppID": 1
}

application/xml, text/xml

Sample:

<LoginModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserName>sample string 1</UserName>
  <Password>sample string 2</Password>
  <LoginRedirectID>1</LoginRedirectID>
  <SiteMapName>sample string 3</SiteMapName>
  <LanguageName>sample string 4</LanguageName>
  <isLoginAzure>true</isLoginAzure>
  <AppID>1</AppID>
</LoginModel>

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 'LoginModel'.

Response Information

Resource Description

If Ok: LoginResult. LoginResult.Token is to be used in every call to All services by including as value for 'X-Session-Token'. See Logout Example. If Error: Unauthorized(401) – invalid user name or password. Forbidden(403) – invalid user status. Error message in Message property. BadRequest(400) – general error. Error message in Message property.

TaskyamWebAPI.Models.Account.LoginResult

Name	Type	Additional information
IsSuccess	boolean	None.
Message	string	None.
Token	string	None.
NeedToChangePassword	boolean	None.
LastLoginDate	date	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Message": "sample string 2",
  "Token": "sample string 3",
  "AzureToken": "sample string 4",
  "User": {
    "Name": "sample string 1",
    "UserName": "sample string 2",
    "Email": "sample string 3",
    "Phone": "sample string 4",
    "Mobile": "sample string 5",
    "Address": "sample string 6",
    "CompanyName": "sample string 7",
    "CompanyNameEng": "sample string 8",
    "CompanyId": "sample string 9",
    "CompanyNum": "sample string 10",
    "CompanyTypes": [
      0,
      0
    ],
    "AgentCodes": [
      "sample string 1",
      "sample string 2"
    ],
    "ShipAgentCodes": "sample string 11",
    "CustomsAgentCodes": "sample string 12",
    "CargoOwnerCodes": "sample string 13",
    "AirlineCodes": "sample string 14",
    "LastLoginDate": "2024-05-18T12:03:54.145457+03:00",
    "ExpiredDate": "2024-05-18T12:03:54.145457+03:00",
    "UserTypeInCompany": 0,
    "LastLoginDateFormated": "12:03 18/05/2024",
    "UserId": "sample string 17",
    "UserIdNumber": "sample string 18",
    "IsCargoOwner": true,
    "UserConfirmationDate": "2024-05-18T12:03:54.145457+03:00",
    "UNLocodesString": "sample string 20"
  },
  "InvalidLoginType": 0,
  "NeedToChangePassword": true,
  "LastLoginDate": "2024-05-18T12:03:54.145457+03:00",
  "RedirectUrl": "sample string 7",
  "AuthorizedMenu": "sample string 8"
}

application/xml, text/xml

Sample:

<LoginResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <Token>sample string 3</Token>
  <NeedToChangePassword>true</NeedToChangePassword>
  <LastLoginDate>2024-05-18T12:03:54.145457+03:00</LastLoginDate>
</LoginResult>