POST Dashboard/HeatMapItems

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.BusinessIntelligence.BIReportViewModel
NameDescriptionTypeAdditional information
SelectedCompanies

Collection of integer

None.

Start

date

None.

End

date

None.

StartDateObjectString

string

None.

EndDateObjectString

string

None.

SkipTimeZoneConvertion

boolean

None.

ForceImmediateExport

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "SelectedCompanies": [
    1,
    2
  ],
  "Start": "2024-10-18T04:33:35.6410174-04:00",
  "End": "2024-10-18T04:33:35.6410174-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":33,\"seconds\":35,\"miliseconds\":641}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":33,\"seconds\":35,\"miliseconds\":641}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/xml, text/xml

Sample:
<BIReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.BusinessIntelligence">
  <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:33:35.6410174-04:00</_x003C_End_x003E_k__BackingField>
  <_x003C_ForceImmediateExport_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_ForceImmediateExport_x003E_k__BackingField>
  <_x003C_SkipTimeZoneConvertion_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_SkipTimeZoneConvertion_x003E_k__BackingField>
  <_x003C_Start_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:33:35.6410174-04:00</_x003C_Start_x003E_k__BackingField>
  <_x003C_SelectedCompanies_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </_x003C_SelectedCompanies_x003E_k__BackingField>
</BIReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IConnect.Domain.Dashboard.DashboardHeatMapItem
NameDescriptionTypeAdditional information
CompanyId

integer

None.

CompanyName

string

None.

Longitude

decimal number

None.

Latitude

decimal number

None.

Total

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CompanyId": 1,
    "CompanyName": "sample string 2",
    "Longitude": 1.1,
    "Latitude": 1.1,
    "Total": 3.0
  },
  {
    "CompanyId": 1,
    "CompanyName": "sample string 2",
    "Longitude": 1.1,
    "Latitude": 1.1,
    "Total": 3.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfDashboardHeatMapItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
  <DashboardHeatMapItem>
    <CompanyId>1</CompanyId>
    <CompanyName>sample string 2</CompanyName>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <Total>3</Total>
  </DashboardHeatMapItem>
  <DashboardHeatMapItem>
    <CompanyId>1</CompanyId>
    <CompanyName>sample string 2</CompanyName>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <Total>3</Total>
  </DashboardHeatMapItem>
</ArrayOfDashboardHeatMapItem>