POST MarketingRecipientReport/GetDetails

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Page

integer

None.

PageSize

integer

None.

Sorts

Collection of Kendo.Mvc.SortDescriptor

None.

Filters

Collection of Kendo.Mvc.IFilterDescriptor

None.

Groups

Collection of Kendo.Mvc.GroupDescriptor

None.

Aggregates

Collection of Kendo.Mvc.AggregateDescriptor

None.

GroupPaging

boolean

None.

IncludeSubGroupCount

boolean

None.

Skip

integer

None.

Take

integer

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.ReportViewModel
NameDescriptionTypeAdditional information
Criteria

integer

None.

ShowBy

IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport.ShowBy

None.

SelectedCompanies

Collection of integer

None.

GroupByCampaing

boolean

None.

PageIndex

integer

None.

PageSize

integer

None.

ForPdf

boolean

None.

ReportFormat

IConnect.Domain.Reports.ExportFormat

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:
{
  "Criteria": 1,
  "ShowBy": 0,
  "SelectedCompanies": [
    1,
    2
  ],
  "GroupByCampaing": true,
  "PageIndex": 1,
  "PageSize": 1,
  "ForPdf": true,
  "ReportFormat": 1,
  "Start": "2024-10-18T04:32:33.3927579-04:00",
  "End": "2024-10-18T04:32:33.3927579-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":32,\"seconds\":33,\"miliseconds\":392}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":32,\"seconds\":33,\"miliseconds\":392}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/xml, text/xml

Sample:
<ReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.AutomatedMarketingReport">
  <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:32:33.3927579-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:32:33.3927579-04:00</_x003C_Start_x003E_k__BackingField>
  <_x003C_Criteria_x003E_k__BackingField>1</_x003C_Criteria_x003E_k__BackingField>
  <_x003C_ForPdf_x003E_k__BackingField>true</_x003C_ForPdf_x003E_k__BackingField>
  <_x003C_GroupByCampaing_x003E_k__BackingField>true</_x003C_GroupByCampaing_x003E_k__BackingField>
  <_x003C_PageIndex_x003E_k__BackingField>1</_x003C_PageIndex_x003E_k__BackingField>
  <_x003C_PageSize_x003E_k__BackingField>1</_x003C_PageSize_x003E_k__BackingField>
  <_x003C_ReportFormat_x003E_k__BackingField>ExcelXls</_x003C_ReportFormat_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>
  <_x003C_ShowBy_x003E_k__BackingField>ThisPeriod</_x003C_ShowBy_x003E_k__BackingField>
</ReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Kendo.Mvc.UI.DataSourceResult
NameDescriptionTypeAdditional information
Data

Collection of Object

None.

Total

integer

None.

AggregateResults

Collection of Kendo.Mvc.Infrastructure.AggregateResult

None.

Errors

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {},
    {}
  ],
  "Total": 1,
  "AggregateResults": null,
  "Errors": {}
}

application/xml, text/xml

Sample:
<DataSourceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kendo.Mvc.UI">
  <AggregateResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.Mvc.Infrastructure" i:nil="true" />
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </Data>
  <Errors />
  <Total>1</Total>
</DataSourceResult>