POST api/Setting/RetrieveUserSettingDetails

Retrieves user setting details.

Request Information

Parameters

Name	Description	Additional information
request		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "UserID": 1,
  "Token": "sample string 2",
  "FreeText": "sample string 3",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 4,
  "ToIndex": 5,
  "IsWebCalling": true,
  "RequestMode": "sample string 7",
  "Client": "sample string 8",
  "AppVersion": "sample string 9",
  "AppOperatingSystem": "sample string 10",
  "AppName": "sample string 11",
  "MasterUserID": 12,
  "IsRecurringRequest": true
}

text/html

Sample:

{"UserID":1,"Token":"sample string 2","FreeText":"sample string 3","GroupIds":[1,2,3],"FromIndex":4,"ToIndex":5,"IsWebCalling":true,"RequestMode":"sample string 7","Client":"sample string 8","AppVersion":"sample string 9","AppOperatingSystem":"sample string 10","AppName":"sample string 11","MasterUserID":12,"IsRecurringRequest":true}

application/xml, text/xml

Sample:

<APIUserSettingDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.APIModels">
  <AppName xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 11</AppName>
  <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 10</AppOperatingSystem>
  <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 9</AppVersion>
  <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 8</Client>
  <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 3</FreeText>
  <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">4</FromIndex>
  <GroupIds 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>
  </GroupIds>
  <IsRecurringRequest xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsRecurringRequest>
  <IsWebCalling xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsWebCalling>
  <MasterUserID xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">12</MasterUserID>
  <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 7</RequestMode>
  <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">5</ToIndex>
  <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 2</Token>
  <UserID>1</UserID>
</APIUserSettingDetailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "UserDetailData": {
    "ID": 1,
    "UserID": 2,
    "ComponentID": 3,
    "DefaultLanguageCode": "sample string 4",
    "IsBoxViewDefault": true,
    "DisplayViewID": 6,
    "TriggerID": 1,
    "GroupID": 1,
    "TimeZoneValue": 7,
    "CountryCodeId": 1,
    "SecurableID": "9e67dd66-ec47-45a4-a0b3-69059f4983ea",
    "SubComponentID": 1,
    "EntityID": 1,
    "MapPerferenceMode": 1,
    "ShowUnitsOnMap": 1,
    "Latitude": 1.1,
    "Longitude": 1.1,
    "MapFlagTypeId": 8,
    "DefaultPage": "sample string 9",
    "GMTOffset": 10,
    "UserCountryCode": "sample string 11"
  },
  "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:

{"UserDetailData":{"ID":1,"UserID":2,"ComponentID":3,"DefaultLanguageCode":"sample string 4","IsBoxViewDefault":true,"DisplayViewID":6,"TriggerID":1,"GroupID":1,"TimeZoneValue":7,"CountryCodeId":1,"SecurableID":"9e67dd66-ec47-45a4-a0b3-69059f4983ea","SubComponentID":1,"EntityID":1,"MapPerferenceMode":1,"ShowUnitsOnMap":1,"Latitude":1.1,"Longitude":1.1,"MapFlagTypeId":8,"DefaultPage":"sample string 9","GMTOffset":10,"UserCountryCode":"sample string 11"},"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:

<APIUserSettingDetailResponse 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>
  <UserDetailData>
    <ComponentID>3</ComponentID>
    <CountryCodeId>1</CountryCodeId>
    <DefaultLanguageCode>sample string 4</DefaultLanguageCode>
    <DefaultPage>sample string 9</DefaultPage>
    <DisplayViewID>6</DisplayViewID>
    <EntityID>1</EntityID>
    <GMTOffset>10</GMTOffset>
    <GroupID>1</GroupID>
    <ID>1</ID>
    <IsBoxViewDefault>true</IsBoxViewDefault>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <MapFlagTypeId>8</MapFlagTypeId>
    <MapPerferenceMode>1</MapPerferenceMode>
    <SecurableID>9e67dd66-ec47-45a4-a0b3-69059f4983ea</SecurableID>
    <ShowUnitsOnMap>1</ShowUnitsOnMap>
    <SubComponentID>1</SubComponentID>
    <TimeZoneValue>7</TimeZoneValue>
    <TriggerID>1</TriggerID>
    <UserCountryCode>sample string 11</UserCountryCode>
    <UserID>2</UserID>
  </UserDetailData>
</APIUserSettingDetailResponse>