POST AnalysisReport/GenerateReport

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.CustomerReport.AnalysisReport.ReportViewModel
NameDescriptionTypeAdditional information
SelectedCompanies

Collection of integer

None.

SelectedProductType

integer

None.

CategoryChecksums

Collection of integer

None.

SelectedSkuList

Collection of string

None.

SelectedRetentionType

integer

None.

Sales

decimal number

None.

SelectedSalesFilter

IConnect.Core.Enumerations.NumberComparisonType

None.

AverageTicket

decimal number

None.

SelectedAverageTicketFilter

IConnect.Core.Enumerations.NumberComparisonType

None.

NumberOfTickets

integer

None.

SelectedNumberOfTicketsFilter

IConnect.Core.Enumerations.NumberComparisonType

None.

Ticket

decimal number

None.

SelectedTicketFilter

IConnect.Core.Enumerations.NumberComparisonType

None.

ProductTicket

integer

None.

SelectedProductTicketFilter

IConnect.Core.Enumerations.NumberComparisonType

None.

TotalSales

decimal number

None.

SelectedTotalSalesFilter

IConnect.Core.Enumerations.NumberComparisonType

None.

IsMember

boolean

None.

SelectedType

integer

None.

ReceivedDiscount

boolean

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
  ],
  "SelectedProductType": 1,
  "CategoryChecksums": [
    1,
    2
  ],
  "SelectedSkuList": [
    "sample string 1",
    "sample string 2"
  ],
  "SelectedRetentionType": 2,
  "Sales": 1.0,
  "SelectedSalesFilter": 0,
  "AverageTicket": 1.0,
  "SelectedAverageTicketFilter": 0,
  "NumberOfTickets": 1,
  "SelectedNumberOfTicketsFilter": 0,
  "Ticket": 1.0,
  "SelectedTicketFilter": 0,
  "ProductTicket": 1,
  "SelectedProductTicketFilter": 0,
  "TotalSales": 1.0,
  "SelectedTotalSalesFilter": 0,
  "IsMember": true,
  "SelectedType": 4,
  "ReceivedDiscount": true,
  "Start": "2024-10-18T04:35:10.3364757-04:00",
  "End": "2024-10-18T04:35:10.3364757-04:00",
  "StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":35,\"seconds\":10,\"miliseconds\":336}",
  "EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":35,\"seconds\":10,\"miliseconds\":336}",
  "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.CustomerReport.AnalysisReport">
  <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2024-10-18T04:35:10.3364757-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:35:10.3364757-04:00</_x003C_Start_x003E_k__BackingField>
  <_x003C_AverageTicket_x003E_k__BackingField>1</_x003C_AverageTicket_x003E_k__BackingField>
  <_x003C_CategoryChecksums_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </_x003C_CategoryChecksums_x003E_k__BackingField>
  <_x003C_IsMember_x003E_k__BackingField>true</_x003C_IsMember_x003E_k__BackingField>
  <_x003C_NumberOfTickets_x003E_k__BackingField>1</_x003C_NumberOfTickets_x003E_k__BackingField>
  <_x003C_ProductTicket_x003E_k__BackingField>1</_x003C_ProductTicket_x003E_k__BackingField>
  <_x003C_ReceivedDiscount_x003E_k__BackingField>true</_x003C_ReceivedDiscount_x003E_k__BackingField>
  <_x003C_Sales_x003E_k__BackingField>1</_x003C_Sales_x003E_k__BackingField>
  <_x003C_SelectedAverageTicketFilter_x003E_k__BackingField>Greater</_x003C_SelectedAverageTicketFilter_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_SelectedNumberOfTicketsFilter_x003E_k__BackingField>Greater</_x003C_SelectedNumberOfTicketsFilter_x003E_k__BackingField>
  <_x003C_SelectedProductTicketFilter_x003E_k__BackingField>Greater</_x003C_SelectedProductTicketFilter_x003E_k__BackingField>
  <_x003C_SelectedProductType_x003E_k__BackingField>1</_x003C_SelectedProductType_x003E_k__BackingField>
  <_x003C_SelectedRetentionType_x003E_k__BackingField>2</_x003C_SelectedRetentionType_x003E_k__BackingField>
  <_x003C_SelectedSalesFilter_x003E_k__BackingField>Greater</_x003C_SelectedSalesFilter_x003E_k__BackingField>
  <_x003C_SelectedSkuList_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </_x003C_SelectedSkuList_x003E_k__BackingField>
  <_x003C_SelectedTicketFilter_x003E_k__BackingField>Greater</_x003C_SelectedTicketFilter_x003E_k__BackingField>
  <_x003C_SelectedTotalSalesFilter_x003E_k__BackingField>Greater</_x003C_SelectedTotalSalesFilter_x003E_k__BackingField>
  <_x003C_SelectedType_x003E_k__BackingField>4</_x003C_SelectedType_x003E_k__BackingField>
  <_x003C_Ticket_x003E_k__BackingField>1</_x003C_Ticket_x003E_k__BackingField>
  <_x003C_TotalSales_x003E_k__BackingField>1</_x003C_TotalSales_x003E_k__BackingField>
</ReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />