POST BI/Top5Discounts

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:34:18.2555797-04:00",
  "End": "2024-10-18T04:34:18.2555797-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":34,\"seconds\":18,\"miliseconds\":255}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":34,\"seconds\":18,\"miliseconds\":255}",
  "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:34:18.2555797-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:34:18.2555797-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

IConnect.ReportingApi.Core.ApiResponseOfSystem.Collections.Generic.ListOfIConnect.Domain.Dashboard.DashboardTopDiscountItem
NameDescriptionTypeAdditional information
StatusCode

IConnect.ReportingApi.Core.ApiStatusCode

None.
Message

string

None.
Data

Collection of IConnect.Domain.Dashboard.DashboardTopDiscountItem

None.
IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "StatusCode": 0,
  "Message": "sample string 1",
  "Data": [
    {
      "Name": "sample string 1",
      "TotalGiven": 2.0
    },
    {
      "Name": "sample string 1",
      "TotalGiven": 2.0
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample: 
<ApiResponseOfArrayOfDashboardTopDiscountItemaaaYI6zx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.ReportingApi.Core">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Dashboard">
    <d2p1:DashboardTopDiscountItem>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:TotalGiven>2</d2p1:TotalGiven>
    </d2p1:DashboardTopDiscountItem>
    <d2p1:DashboardTopDiscountItem>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:TotalGiven>2</d2p1:TotalGiven>
    </d2p1:DashboardTopDiscountItem>
  </Data>
  <Message>sample string 1</Message>
  <StatusCode>Success</StatusCode>
</ApiResponseOfArrayOfDashboardTopDiscountItemaaaYI6zx>