POST api/Login/login
Validates the user credentials and returns a Token to be used in subsequent request upon success
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
request |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{ "Username": "sample string 1", "Password": "sample string 2", "subUserGUID": "sample string 3", "OverrideLanguage": "sample string 4", "IsVersioningImplemented": true, "Token": "sample string 6", "FreeText": "sample string 7", "GroupIds": [ 1, 2, 3 ], "FromIndex": 8, "ToIndex": 9, "IsWebCalling": true, "RequestMode": "sample string 11", "Client": "sample string 12", "AppVersion": "sample string 13", "AppOperatingSystem": "sample string 14", "AppName": "sample string 15", "MasterUserID": 16, "IsRecurringRequest": true }
text/html
Sample:
{"Username":"sample string 1","Password":"sample string 2","subUserGUID":"sample string 3","OverrideLanguage":"sample string 4","IsVersioningImplemented":true,"Token":"sample string 6","FreeText":"sample string 7","GroupIds":[1,2,3],"FromIndex":8,"ToIndex":9,"IsWebCalling":true,"RequestMode":"sample string 11","Client":"sample string 12","AppVersion":"sample string 13","AppOperatingSystem":"sample string 14","AppName":"sample string 15","MasterUserID":16,"IsRecurringRequest":true}
application/xml, text/xml
Sample:
<APIAuthenticationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels"> <AppName>sample string 15</AppName> <AppOperatingSystem>sample string 14</AppOperatingSystem> <AppVersion>sample string 13</AppVersion> <Client>sample string 12</Client> <FreeText>sample string 7</FreeText> <FromIndex>8</FromIndex> <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> <d2p1:int>3</d2p1:int> </GroupIds> <IsRecurringRequest>true</IsRecurringRequest> <IsWebCalling>true</IsWebCalling> <MasterUserID>16</MasterUserID> <RequestMode>sample string 11</RequestMode> <ToIndex>9</ToIndex> <Token>sample string 6</Token> <IsVersioningImplemented>true</IsVersioningImplemented> <OverrideLanguage>sample string 4</OverrideLanguage> <Password>sample string 2</Password> <Username>sample string 1</Username> <subUserGUID>sample string 3</subUserGUID> </APIAuthenticationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{ "AccessToken": "sample string 1", "Success": true, "ErrorMessage": "sample string 3", "MenuAccessData": { "HasAccessToMap": true, "HasAccessToVehicle": true, "HasAccessToVehicleAdministration": true, "HasAccessToDriver": true, "HasAccessToPOI": true, "HasAccessToReports": true, "HasAccessToSettings": true, "HasAccessToTrips": true, "HasAccessToTranslations": true, "HasAccessToDashboard": true, "HasAccessToLogBook": true, "HasAccessToGroup": true, "HasAccessToTemplate": true, "HasAccessToUnit": true, "HasAccessToUser": true, "HasAccessToTicket": true, "HasAccessToContract": true, "HasAccessToSIM": true, "HasAccessToCommand": true, "HasAccessToUnitProfile": true, "HasAccessToProfileTrigger": true, "HasAccessToScript": true, "HasAccessToTriggerSchedule": true }, "StatusCode": 4, "ComponentFilterIds": [ 1, 2, 3 ] }
text/html
Sample:
{"AccessToken":"sample string 1","Success":true,"ErrorMessage":"sample string 3","MenuAccessData":{"HasAccessToMap":true,"HasAccessToVehicle":true,"HasAccessToVehicleAdministration":true,"HasAccessToDriver":true,"HasAccessToPOI":true,"HasAccessToReports":true,"HasAccessToSettings":true,"HasAccessToTrips":true,"HasAccessToTranslations":true,"HasAccessToDashboard":true,"HasAccessToLogBook":true,"HasAccessToGroup":true,"HasAccessToTemplate":true,"HasAccessToUnit":true,"HasAccessToUser":true,"HasAccessToTicket":true,"HasAccessToContract":true,"HasAccessToSIM":true,"HasAccessToCommand":true,"HasAccessToUnitProfile":true,"HasAccessToProfileTrigger":true,"HasAccessToScript":true,"HasAccessToTriggerSchedule":true},"StatusCode":4,"ComponentFilterIds":[1,2,3]}
application/xml, text/xml
Sample:
<APILoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.APIModels"> <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.Transport">Success</ResponseCode> <ComponentFilterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> <d2p1:int>3</d2p1:int> </ComponentFilterIds> <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 3</ErrorMessage> <MenuAccessData xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels"> <HasAccessToCommand>true</HasAccessToCommand> <HasAccessToContract>true</HasAccessToContract> <HasAccessToDashboard>true</HasAccessToDashboard> <HasAccessToDriver>true</HasAccessToDriver> <HasAccessToGroup>true</HasAccessToGroup> <HasAccessToLogBook>true</HasAccessToLogBook> <HasAccessToMap>true</HasAccessToMap> <HasAccessToPOI>true</HasAccessToPOI> <HasAccessToProfileTrigger>true</HasAccessToProfileTrigger> <HasAccessToReports>true</HasAccessToReports> <HasAccessToSIM>true</HasAccessToSIM> <HasAccessToScript>true</HasAccessToScript> <HasAccessToSettings>true</HasAccessToSettings> <HasAccessToTemplate>true</HasAccessToTemplate> <HasAccessToTicket>true</HasAccessToTicket> <HasAccessToTranslations>true</HasAccessToTranslations> <HasAccessToTriggerSchedule>true</HasAccessToTriggerSchedule> <HasAccessToTrips>true</HasAccessToTrips> <HasAccessToUnit>true</HasAccessToUnit> <HasAccessToUnitProfile>true</HasAccessToUnitProfile> <HasAccessToUser>true</HasAccessToUser> <HasAccessToVehicle>true</HasAccessToVehicle> <HasAccessToVehicleAdministration>true</HasAccessToVehicleAdministration> </MenuAccessData> <StatusCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">4</StatusCode> <Success xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</Success> <AccessToken>sample string 1</AccessToken> </APILoginResponse>