POST api/Login/GetUserDetails
Get the user details
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| request |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"IsRecurringRequest": true,
"Token": "sample string 2",
"Client": "sample string 3",
"FreeText": "sample string 4",
"IsWebCalling": true,
"AppName": "sample string 6",
"GroupIds": [
1,
2,
3
],
"FromIndex": 7,
"ToIndex": 8,
"RequestMode": "sample string 9",
"AppVersion": "sample string 10",
"AppOperatingSystem": "sample string 11",
"MasterUserID": 12
}
text/html
Sample:
{"IsRecurringRequest":true,"Token":"sample string 2","Client":"sample string 3","FreeText":"sample string 4","IsWebCalling":true,"AppName":"sample string 6","GroupIds":[1,2,3],"FromIndex":7,"ToIndex":8,"RequestMode":"sample string 9","AppVersion":"sample string 10","AppOperatingSystem":"sample string 11","MasterUserID":12}
application/xml, text/xml
Sample:
<APIBaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<AppName>sample string 6</AppName>
<AppOperatingSystem>sample string 11</AppOperatingSystem>
<AppVersion>sample string 10</AppVersion>
<Client>sample string 3</Client>
<FreeText>sample string 4</FreeText>
<FromIndex>7</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>12</MasterUserID>
<RequestMode>sample string 9</RequestMode>
<ToIndex>8</ToIndex>
<Token>sample string 2</Token>
</APIBaseRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{
"UserAuthenticationDetails": {
"UserDetailsWithSettings": {
"ID": 1,
"UserName": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"Email": "sample string 5",
"DriverID": 6,
"RoleID": 1,
"RoleName": "sample string 7",
"DefaultComponentID": 8,
"DefaultLanguageCode": "sample string 9",
"DisplayViewID": 10,
"PhoneWork": "sample string 11",
"PhoneCell": "sample string 12",
"SecurableID": "79235e5e-4f1c-4a0e-8f6f-101567809d1c",
"SubComponentID": 1,
"EntityID": 1,
"GroupID": 1,
"TripStartsPrivate": true,
"TimeZoneValue": 14,
"MapPerfernceMode": 1,
"DriverRoleID": 15,
"CanViewPrivateTrips": true,
"IsMapDefaultFlagEnable": true,
"AutoRefreshDurationMobile": 18,
"CountryCodeId": 1,
"DashboardId": 1,
"Latitude": 1.1,
"Longitude": 1.1,
"MapFlagTypeId": 1,
"CurrentVehicleId": 19,
"ShowUnitsOnMap": 1,
"GMTOffset": 20,
"ImageName": "sample string 21",
"EmploymentNo": "sample string 22",
"DefaultGroupName": "sample string 23",
"DefaultGroupDesc": "sample string 24",
"UserCountryCode": "sample string 25",
"DefaultGroupIds": [
1,
2,
3
],
"DefaultGroupNameCSV": "sample string 26",
"ShowFlagAtZoomLevel": 1,
"ShowFlagWhenUnitCount": 1,
"CurrentVehicleRegistrationName": "sample string 27",
"DisableClusteringAtZoomLevel": 1,
"MapTileProviderId": 28,
"UnitOfMeasureID": 1,
"MaxParallelAPILimit": 1
},
"AccessToken": "sample string 1",
"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
},
"CreationRights": {
"CanCreateVehicle": true,
"CanCreatePOI": true,
"CanCreateDriver": true,
"CanCreateUnit": true,
"CanCreateGroup": true,
"CanCreateTemplate": true,
"CanCreateUser": true,
"CanCreateTicket": true,
"CanCreateContract": true,
"CanCreateSIM": true,
"CanCreateCommand": true,
"CanCreateConfigTrigger": true,
"CanCreateUnitProfile": true,
"CanConfigureUnit": true,
"CanCreateTriggerSchedule": true
},
"ComponentWithTheirFilters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4",
"sample string 5": "sample string 6"
},
"HasTranslationUpdateRights": true,
"HasTemplateUpdateRights": true,
"HasTemplateDeleteRights": true,
"HasTripLogicUpdateRights": true,
"CurrentYear": 6
},
"Success": true,
"ErrorMessage": "sample string 2",
"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": 3,
"ComponentFilterIds": [
1,
2,
3
]
}
text/html
Sample:
{"UserAuthenticationDetails":{"UserDetailsWithSettings":{"ID":1,"UserName":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","Email":"sample string 5","DriverID":6,"RoleID":1,"RoleName":"sample string 7","DefaultComponentID":8,"DefaultLanguageCode":"sample string 9","DisplayViewID":10,"PhoneWork":"sample string 11","PhoneCell":"sample string 12","SecurableID":"79235e5e-4f1c-4a0e-8f6f-101567809d1c","SubComponentID":1,"EntityID":1,"GroupID":1,"TripStartsPrivate":true,"TimeZoneValue":14,"MapPerfernceMode":1,"DriverRoleID":15,"CanViewPrivateTrips":true,"IsMapDefaultFlagEnable":true,"AutoRefreshDurationMobile":18,"CountryCodeId":1,"DashboardId":1,"Latitude":1.1,"Longitude":1.1,"MapFlagTypeId":1,"CurrentVehicleId":19,"ShowUnitsOnMap":1,"GMTOffset":20,"ImageName":"sample string 21","EmploymentNo":"sample string 22","DefaultGroupName":"sample string 23","DefaultGroupDesc":"sample string 24","UserCountryCode":"sample string 25","DefaultGroupIds":[1,2,3],"DefaultGroupNameCSV":"sample string 26","ShowFlagAtZoomLevel":1,"ShowFlagWhenUnitCount":1,"CurrentVehicleRegistrationName":"sample string 27","DisableClusteringAtZoomLevel":1,"MapTileProviderId":28,"UnitOfMeasureID":1,"MaxParallelAPILimit":1},"AccessToken":"sample string 1","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},"CreationRights":{"CanCreateVehicle":true,"CanCreatePOI":true,"CanCreateDriver":true,"CanCreateUnit":true,"CanCreateGroup":true,"CanCreateTemplate":true,"CanCreateUser":true,"CanCreateTicket":true,"CanCreateContract":true,"CanCreateSIM":true,"CanCreateCommand":true,"CanCreateConfigTrigger":true,"CanCreateUnitProfile":true,"CanConfigureUnit":true,"CanCreateTriggerSchedule":true},"ComponentWithTheirFilters":{"sample string 1":"sample string 2","sample string 3":"sample string 4","sample string 5":"sample string 6"},"HasTranslationUpdateRights":true,"HasTemplateUpdateRights":true,"HasTemplateDeleteRights":true,"HasTripLogicUpdateRights":true,"CurrentYear":6},"Success":true,"ErrorMessage":"sample string 2","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":3,"ComponentFilterIds":[1,2,3]}
application/xml, text/xml
Sample:
<APIGetUserDetailsResponse 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 2</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">3</StatusCode>
<Success xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</Success>
<UserAuthenticationDetails>
<AccessToken>sample string 1</AccessToken>
<ComponentWithTheirFilters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 5</d3p1:Key>
<d3p1:Value>sample string 6</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</ComponentWithTheirFilters>
<CreationRights xmlns:d3p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<d3p1:CanConfigureUnit>true</d3p1:CanConfigureUnit>
<d3p1:CanCreateCommand>true</d3p1:CanCreateCommand>
<d3p1:CanCreateConfigTrigger>true</d3p1:CanCreateConfigTrigger>
<d3p1:CanCreateContract>true</d3p1:CanCreateContract>
<d3p1:CanCreateDriver>true</d3p1:CanCreateDriver>
<d3p1:CanCreateGroup>true</d3p1:CanCreateGroup>
<d3p1:CanCreatePOI>true</d3p1:CanCreatePOI>
<d3p1:CanCreateSIM>true</d3p1:CanCreateSIM>
<d3p1:CanCreateTemplate>true</d3p1:CanCreateTemplate>
<d3p1:CanCreateTicket>true</d3p1:CanCreateTicket>
<d3p1:CanCreateTriggerSchedule>true</d3p1:CanCreateTriggerSchedule>
<d3p1:CanCreateUnit>true</d3p1:CanCreateUnit>
<d3p1:CanCreateUnitProfile>true</d3p1:CanCreateUnitProfile>
<d3p1:CanCreateUser>true</d3p1:CanCreateUser>
<d3p1:CanCreateVehicle>true</d3p1:CanCreateVehicle>
</CreationRights>
<CurrentYear>6</CurrentYear>
<HasTemplateDeleteRights>true</HasTemplateDeleteRights>
<HasTemplateUpdateRights>true</HasTemplateUpdateRights>
<HasTranslationUpdateRights>true</HasTranslationUpdateRights>
<HasTripLogicUpdateRights>true</HasTripLogicUpdateRights>
<MenuAccessData xmlns:d3p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<d3p1:HasAccessToCommand>true</d3p1:HasAccessToCommand>
<d3p1:HasAccessToContract>true</d3p1:HasAccessToContract>
<d3p1:HasAccessToDashboard>true</d3p1:HasAccessToDashboard>
<d3p1:HasAccessToDriver>true</d3p1:HasAccessToDriver>
<d3p1:HasAccessToGroup>true</d3p1:HasAccessToGroup>
<d3p1:HasAccessToLogBook>true</d3p1:HasAccessToLogBook>
<d3p1:HasAccessToMap>true</d3p1:HasAccessToMap>
<d3p1:HasAccessToPOI>true</d3p1:HasAccessToPOI>
<d3p1:HasAccessToProfileTrigger>true</d3p1:HasAccessToProfileTrigger>
<d3p1:HasAccessToReports>true</d3p1:HasAccessToReports>
<d3p1:HasAccessToSIM>true</d3p1:HasAccessToSIM>
<d3p1:HasAccessToScript>true</d3p1:HasAccessToScript>
<d3p1:HasAccessToSettings>true</d3p1:HasAccessToSettings>
<d3p1:HasAccessToTemplate>true</d3p1:HasAccessToTemplate>
<d3p1:HasAccessToTicket>true</d3p1:HasAccessToTicket>
<d3p1:HasAccessToTranslations>true</d3p1:HasAccessToTranslations>
<d3p1:HasAccessToTriggerSchedule>true</d3p1:HasAccessToTriggerSchedule>
<d3p1:HasAccessToTrips>true</d3p1:HasAccessToTrips>
<d3p1:HasAccessToUnit>true</d3p1:HasAccessToUnit>
<d3p1:HasAccessToUnitProfile>true</d3p1:HasAccessToUnitProfile>
<d3p1:HasAccessToUser>true</d3p1:HasAccessToUser>
<d3p1:HasAccessToVehicle>true</d3p1:HasAccessToVehicle>
<d3p1:HasAccessToVehicleAdministration>true</d3p1:HasAccessToVehicleAdministration>
</MenuAccessData>
<UserDetailsWithSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<d3p1:AutoRefreshDurationMobile>18</d3p1:AutoRefreshDurationMobile>
<d3p1:CanViewPrivateTrips>true</d3p1:CanViewPrivateTrips>
<d3p1:CountryCodeId>1</d3p1:CountryCodeId>
<d3p1:CurrentVehicleId>19</d3p1:CurrentVehicleId>
<d3p1:CurrentVehicleRegistrationName>sample string 27</d3p1:CurrentVehicleRegistrationName>
<d3p1:DashboardId>1</d3p1:DashboardId>
<d3p1:DefaultComponentID>8</d3p1:DefaultComponentID>
<d3p1:DefaultGroupDesc>sample string 24</d3p1:DefaultGroupDesc>
<d3p1:DefaultGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
<d4p1:int>3</d4p1:int>
</d3p1:DefaultGroupIds>
<d3p1:DefaultGroupName>sample string 23</d3p1:DefaultGroupName>
<d3p1:DefaultGroupNameCSV>sample string 26</d3p1:DefaultGroupNameCSV>
<d3p1:DefaultLanguageCode>sample string 9</d3p1:DefaultLanguageCode>
<d3p1:DisableClusteringAtZoomLevel>1</d3p1:DisableClusteringAtZoomLevel>
<d3p1:DisplayViewID>10</d3p1:DisplayViewID>
<d3p1:DriverID>6</d3p1:DriverID>
<d3p1:DriverRoleID>15</d3p1:DriverRoleID>
<d3p1:Email>sample string 5</d3p1:Email>
<d3p1:EmploymentNo>sample string 22</d3p1:EmploymentNo>
<d3p1:EntityID>1</d3p1:EntityID>
<d3p1:FirstName>sample string 3</d3p1:FirstName>
<d3p1:GMTOffset>20</d3p1:GMTOffset>
<d3p1:GroupID>1</d3p1:GroupID>
<d3p1:ID>1</d3p1:ID>
<d3p1:ImageName>sample string 21</d3p1:ImageName>
<d3p1:IsMapDefaultFlagEnable>true</d3p1:IsMapDefaultFlagEnable>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:Latitude>1.1</d3p1:Latitude>
<d3p1:Longitude>1.1</d3p1:Longitude>
<d3p1:MapFlagTypeId>1</d3p1:MapFlagTypeId>
<d3p1:MapPerfernceMode>1</d3p1:MapPerfernceMode>
<d3p1:MapTileProviderId>28</d3p1:MapTileProviderId>
<d3p1:MaxParallelAPILimit>1</d3p1:MaxParallelAPILimit>
<d3p1:PhoneCell>sample string 12</d3p1:PhoneCell>
<d3p1:PhoneWork>sample string 11</d3p1:PhoneWork>
<d3p1:RoleID>1</d3p1:RoleID>
<d3p1:RoleName>sample string 7</d3p1:RoleName>
<d3p1:SecurableID>79235e5e-4f1c-4a0e-8f6f-101567809d1c</d3p1:SecurableID>
<d3p1:ShowFlagAtZoomLevel>1</d3p1:ShowFlagAtZoomLevel>
<d3p1:ShowFlagWhenUnitCount>1</d3p1:ShowFlagWhenUnitCount>
<d3p1:ShowUnitsOnMap>1</d3p1:ShowUnitsOnMap>
<d3p1:SubComponentID>1</d3p1:SubComponentID>
<d3p1:TimeZoneValue>14</d3p1:TimeZoneValue>
<d3p1:TripStartsPrivate>true</d3p1:TripStartsPrivate>
<d3p1:UnitOfMeasureID>1</d3p1:UnitOfMeasureID>
<d3p1:UserCountryCode>sample string 25</d3p1:UserCountryCode>
<d3p1:UserName>sample string 2</d3p1:UserName>
</UserDetailsWithSettings>
</UserAuthenticationDetails>
</APIGetUserDetailsResponse>