POST api/DataExport/export

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
SiteId	integer	None.
CurrentReportPreGenerated	boolean	None.
ReportId	integer	None.
ReportStartDate	date	None.
ReportEndDate	date	None.
FilterType	string	None.
OrderStatusIDs	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteId": 1,
  "CurrentReportPreGenerated": true,
  "ReportId": 1,
  "ReportStartDate": "2025-12-20T18:19:29.1823104+00:00",
  "ReportEndDate": "2025-12-20T18:19:29.1823104+00:00",
  "FilterType": "sample string 3",
  "OrderStatusIDs": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<DataExportModelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CurrentReportPreGenerated>true</CurrentReportPreGenerated>
  <FilterType>sample string 3</FilterType>
  <OrderStatusIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrderStatusIDs>
  <ReportEndDate>2025-12-20T18:19:29.1823104+00:00</ReportEndDate>
  <ReportId>1</ReportId>
  <ReportStartDate>2025-12-20T18:19:29.1823104+00:00</ReportStartDate>
  <SiteId>1</SiteId>
</DataExportModelRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DataExportModelResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.
Model	ReportingDashboardModel	None.
Errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "ReportData": null,
    "Sites": null,
    "Reports": null,
    "CurrentSite": 1,
    "CurrentCulture": "sample string 2",
    "CurrentLocaleID": 3,
    "CurrentReportID": 4,
    "CurrentReport": "sample string 5",
    "DateFilters": null,
    "FilterType": "sample string 6",
    "ValidationError": true,
    "IsDownloadOnly": true,
    "IsDownloadRequest": true,
    "OrderStatusCode": "sample string 10",
    "ReportStartDate": "sample string 11",
    "ReportEndDate": "sample string 12",
    "OrderStatusIDs": [
      1,
      2
    ],
    "ApiVersion": 13,
    "EnableExport": true,
    "ReportsPreGenerated": null,
    "CurrentReportPreGenerated": true,
    "NumericalColumnsForSort": [
      1,
      2
    ]
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<DataExportModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Message>sample string 1</Message>
  <Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:ApiVersion>13</d2p1:ApiVersion>
    <d2p1:CurrentCulture>sample string 2</d2p1:CurrentCulture>
    <d2p1:CurrentLocaleID>3</d2p1:CurrentLocaleID>
    <d2p1:CurrentReport>sample string 5</d2p1:CurrentReport>
    <d2p1:CurrentReportID>4</d2p1:CurrentReportID>
    <d2p1:CurrentReportPreGenerated>true</d2p1:CurrentReportPreGenerated>
    <d2p1:CurrentSite>1</d2p1:CurrentSite>
    <d2p1:DateFilters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:EnableExport>true</d2p1:EnableExport>
    <d2p1:FilterType>sample string 6</d2p1:FilterType>
    <d2p1:IsDownloadOnly>true</d2p1:IsDownloadOnly>
    <d2p1:IsDownloadRequest>true</d2p1:IsDownloadRequest>
    <d2p1:NumericalColumnsForSort xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:NumericalColumnsForSort>
    <d2p1:OrderStatusCode>sample string 10</d2p1:OrderStatusCode>
    <d2p1:OrderStatusIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:OrderStatusIDs>
    <d2p1:ReportData i:nil="true" />
    <d2p1:ReportEndDate>sample string 12</d2p1:ReportEndDate>
    <d2p1:ReportStartDate>sample string 11</d2p1:ReportStartDate>
    <d2p1:Reports xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:ReportsPreGenerated xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:ValidationError>true</d2p1:ValidationError>
  </Model>
  <ResponseCode>Success</ResponseCode>
</DataExportModelResponse>