POST api/DataExport

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional Information
SiteCode		string	None.
VerificationKey		string	None.
TimestampUTC		string	None.
APIUsername	Use it to get the API key from user table to verify the verification key (optional)	string	None.
DataSetName		string	None.
ReportStart		date	None.
ReportEnd		date	None.
SiteID		integer	None.
FilterType		string	None.
Seperator		string	None.
ForceManualRun	If you're calling this manually, you'll need to pass this as true to guarantee it will generate the report requested.	boolean	None.
ApiVersion		integer	None.
ConfigValues		Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteCode": "sample string 1",
  "VerificationKey": "sample string 2",
  "TimestampUTC": "sample string 3",
  "APIUsername": "sample string 4",
  "DataSetName": "sample string 5",
  "ReportStart": "2025-12-20T18:19:36.9958975+00:00",
  "ReportEnd": "2025-12-20T18:19:36.9958975+00:00",
  "SiteID": 8,
  "FilterType": "sample string 9",
  "Seperator": "sample string 10",
  "ForceManualRun": true,
  "ApiVersion": 12,
  "ConfigValues": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<DataExportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.WebApi.Logic">
  <APIUsername>sample string 4</APIUsername>
  <ApiVersion>12</ApiVersion>
  <ConfigValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ConfigValues>
  <DataSetName>sample string 5</DataSetName>
  <FilterType>sample string 9</FilterType>
  <ForceManualRun>true</ForceManualRun>
  <ReportEnd>2025-12-20T18:19:36.9958975+00:00</ReportEnd>
  <ReportStart>2025-12-20T18:19:36.9958975+00:00</ReportStart>
  <Seperator>sample string 10</Seperator>
  <SiteCode>sample string 1</SiteCode>
  <SiteID>8</SiteID>
  <TimestampUTC>sample string 3</TimestampUTC>
  <VerificationKey>sample string 2</VerificationKey>
</DataExportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>