GET api/DownloadReport/{id}?systemName={systemName}&username={username}&password={password}&fromDate={fromDate}&toDate={toDate}&networkId={networkId}&providerId={providerId}&providerFeedId={providerFeedId}

Gets the data for a completed report

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

systemName

string

Required

username

string

Required

password

string

Required

fromDate

string

None.

toDate

string

None.

networkId

integer

Default value is 0

providerId

integer

Default value is 0

providerFeedId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

APIReport
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

Status

Queued, Processing, Ready, Error or Suspended

string

None.

Title

Title of report

string

None.

Dates

Dates included in report

string

None.

Column

List of column labels

Collection of string

None.

Row

List of APIReportRow

Collection of APIReportRow

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "status": "sample string 2",
  "title": "sample string 3",
  "dates": "sample string 4",
  "column": [
    "sample string 1",
    "sample string 2"
  ],
  "row": [
    {
      "cell": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "cell": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<APIReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <Column xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Column>
  <Dates>sample string 4</Dates>
  <Id>1</Id>
  <Row>
    <APIReportRow>
      <Cell xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Cell>
    </APIReportRow>
    <APIReportRow>
      <Cell xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Cell>
    </APIReportRow>
  </Row>
  <Status>sample string 2</Status>
  <Title>sample string 3</Title>
</APIReport>