POST api/DataExport

Request Information

URI Parameters

None.

Body Parameters

DataExportRequest

NameDescriptionTypeAdditional 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.
ApiVersion

integer

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-20T17:48:11.2329741+00:00",
  "ReportEnd": "2025-12-20T17:48:11.2329741+00:00",
  "SiteID": 8,
  "FilterType": "sample string 9",
  "Seperator": "sample string 10",
  "ApiVersion": 11
}

application/xml, text/xml

Sample: 
<DataExportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.WebApi.Controllers">
  <APIUsername>sample string 4</APIUsername>
  <ApiVersion>11</ApiVersion>
  <DataSetName>sample string 5</DataSetName>
  <FilterType>sample string 9</FilterType>
  <ReportEnd>2025-12-20T17:48:11.2329741+00:00</ReportEnd>
  <ReportStart>2025-12-20T17:48:11.2329741+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

NameDescriptionTypeAdditional information
ResponseCode

APIResponseCodes

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseCode": 0,
  "Message": "sample string 1"
}

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">
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>