POST GenericReport/GetReportParameters

Request Information

URI Parameters

None.

Body Parameters

ReportRequest
NameDescriptionTypeAdditional information
ReportId

integer

None.

ReportIdentifier

string

None.

rptData

ReportData

None.

GetParamData

boolean

None.

Action

ActionType

None.

isRPTReport

boolean

None.

Parameters

Dictionary of string [key] and string [value]

None.

WebParameters

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "ReportId": 1,
  "ReportIdentifier": "sample string 2",
  "rptData": 0,
  "GetParamData": true,
  "Action": 0,
  "isRPTReport": true,
  "Parameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "WebParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
  <Action>View</Action>
  <GetParamData>true</GetParamData>
  <Parameters 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>
  </Parameters>
  <ReportId>1</ReportId>
  <ReportIdentifier>sample string 2</ReportIdentifier>
  <WebParameters 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>
  </WebParameters>
  <isRPTReport>true</isRPTReport>
  <rptData>ReportParameters</rptData>
</ReportRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ReportRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.