POST api/Dashboard/RetrieveComponentScoreData
No documentation available.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
request | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{ "DashboardComponentIds": "sample string 1", "DashboardComponentScoreIDs": "sample string 2", "Token": "sample string 3", "FreeText": "sample string 4", "GroupIds": [ 1, 2, 3 ], "FromIndex": 5, "ToIndex": 6, "IsWebCalling": true, "RequestMode": "sample string 8", "Client": "sample string 9", "AppVersion": "sample string 10", "AppOperatingSystem": "sample string 11", "AppName": "sample string 12", "MasterUserID": 13, "IsRecurringRequest": true }
text/html
Sample:
{"DashboardComponentIds":"sample string 1","DashboardComponentScoreIDs":"sample string 2","Token":"sample string 3","FreeText":"sample string 4","GroupIds":[1,2,3],"FromIndex":5,"ToIndex":6,"IsWebCalling":true,"RequestMode":"sample string 8","Client":"sample string 9","AppVersion":"sample string 10","AppOperatingSystem":"sample string 11","AppName":"sample string 12","MasterUserID":13,"IsRecurringRequest":true}
application/xml, text/xml
Sample:
<APIDashboardComponentMyScoreRequest 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 12</AppName> <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 11</AppOperatingSystem> <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 10</AppVersion> <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 9</Client> <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 4</FreeText> <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">5</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">13</MasterUserID> <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 8</RequestMode> <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">6</ToIndex> <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 3</Token> <DashboardComponentIds>sample string 1</DashboardComponentIds> <DashboardComponentScoreIDs>sample string 2</DashboardComponentScoreIDs> </APIDashboardComponentMyScoreRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
No documentation available.
Response body formats
application/json, text/json
Sample:
{ "DashboardComponent": { "ChartScoreDataList": [ { "ComponentId": 1, "Today": 2.1, "ThisMonth": 3.1, "ThisWeek": 4.1, "ThreeMonth": 5.1, "DateLabel": "sample string 6", "Value1": 7.1, "Value2": 8.1 }, { "ComponentId": 1, "Today": 2.1, "ThisMonth": 3.1, "ThisWeek": 4.1, "ThreeMonth": 5.1, "DateLabel": "sample string 6", "Value1": 7.1, "Value2": 8.1 }, { "ComponentId": 1, "Today": 2.1, "ThisMonth": 3.1, "ThisWeek": 4.1, "ThreeMonth": 5.1, "DateLabel": "sample string 6", "Value1": 7.1, "Value2": 8.1 } ], "AvgData": 1.1, "AvgDataWeek": 2.1, "AvgDataToday": 3.1, "ReportID": 4 }, "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:
{"DashboardComponent":{"ChartScoreDataList":[{"ComponentId":1,"Today":2.1,"ThisMonth":3.1,"ThisWeek":4.1,"ThreeMonth":5.1,"DateLabel":"sample string 6","Value1":7.1,"Value2":8.1},{"ComponentId":1,"Today":2.1,"ThisMonth":3.1,"ThisWeek":4.1,"ThreeMonth":5.1,"DateLabel":"sample string 6","Value1":7.1,"Value2":8.1},{"ComponentId":1,"Today":2.1,"ThisMonth":3.1,"ThisWeek":4.1,"ThreeMonth":5.1,"DateLabel":"sample string 6","Value1":7.1,"Value2":8.1}],"AvgData":1.1,"AvgDataWeek":2.1,"AvgDataToday":3.1,"ReportID":4},"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:
<APIDashboardComponentScoreResponse 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> <DashboardComponent> <AvgData>1.1</AvgData> <AvgDataToday>3.1</AvgDataToday> <AvgDataWeek>2.1</AvgDataWeek> <ChartScoreDataList> <APIDashboardComponentScoreChartData> <ComponentId>1</ComponentId> <DateLabel>sample string 6</DateLabel> <ThisMonth>3.1</ThisMonth> <ThisWeek>4.1</ThisWeek> <ThreeMonth>5.1</ThreeMonth> <Today>2.1</Today> <Value1>7.1</Value1> <Value2>8.1</Value2> </APIDashboardComponentScoreChartData> <APIDashboardComponentScoreChartData> <ComponentId>1</ComponentId> <DateLabel>sample string 6</DateLabel> <ThisMonth>3.1</ThisMonth> <ThisWeek>4.1</ThisWeek> <ThreeMonth>5.1</ThreeMonth> <Today>2.1</Today> <Value1>7.1</Value1> <Value2>8.1</Value2> </APIDashboardComponentScoreChartData> <APIDashboardComponentScoreChartData> <ComponentId>1</ComponentId> <DateLabel>sample string 6</DateLabel> <ThisMonth>3.1</ThisMonth> <ThisWeek>4.1</ThisWeek> <ThreeMonth>5.1</ThreeMonth> <Today>2.1</Today> <Value1>7.1</Value1> <Value2>8.1</Value2> </APIDashboardComponentScoreChartData> </ChartScoreDataList> <ReportID>4</ReportID> </DashboardComponent> </APIDashboardComponentScoreResponse>