POST api/ReportClient/GenerateReport

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ReportID	integer	None.
ReportContent	Collection of byte	None.
ReportDisplayName	string	None.
ReportTypeID	ReportTypeID	None.
ReportParameterList	Collection of ReportParameterModel	None.
Report_ExportFormatID	Report_ExportFormatID	None.
Response	IResponse	None.

Request Formats

application/json, text/json

Sample:

{
  "ReportID": 1,
  "ReportContent": "QEA=",
  "ReportDisplayName": "sample string 1",
  "ReportTypeID": 1,
  "ReportParameterList": [
    {
      "ReportParameterID": 1,
      "ReportID": 1,
      "ReportParameterTypeID": 1,
      "ParameterName": "sample string 1",
      "FriendlyName": "sample string 2",
      "DisplayOrder": 1,
      "DataTypeID": 1,
      "IsMandatory": true,
      "SelectedValue": {},
      "PopulatorValues": {}
    },
    {
      "ReportParameterID": 1,
      "ReportID": 1,
      "ReportParameterTypeID": 1,
      "ParameterName": "sample string 1",
      "FriendlyName": "sample string 2",
      "DisplayOrder": 1,
      "DataTypeID": 1,
      "IsMandatory": true,
      "SelectedValue": {},
      "PopulatorValues": {}
    }
  ],
  "Report_ExportFormatID": 1,
  "Response": null
}

application/xml, text/xml

Sample:

<ReportVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Report">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <ReportContent>QEA=</ReportContent>
  <ReportDisplayName>sample string 1</ReportDisplayName>
  <ReportID>1</ReportID>
  <ReportParameterList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.ReportParameter">
    <d2p1:ReportParameterModel>
      <d2p1:DataTypeID>1</d2p1:DataTypeID>
      <d2p1:DisplayOrder>1</d2p1:DisplayOrder>
      <d2p1:FriendlyName>sample string 2</d2p1:FriendlyName>
      <d2p1:IsMandatory>true</d2p1:IsMandatory>
      <d2p1:ParameterName>sample string 1</d2p1:ParameterName>
      <d2p1:PopulatorValues />
      <d2p1:ReportID>1</d2p1:ReportID>
      <d2p1:ReportParameterID>1</d2p1:ReportParameterID>
      <d2p1:ReportParameterTypeID>1</d2p1:ReportParameterTypeID>
      <d2p1:SelectedValue />
    </d2p1:ReportParameterModel>
    <d2p1:ReportParameterModel>
      <d2p1:DataTypeID>1</d2p1:DataTypeID>
      <d2p1:DisplayOrder>1</d2p1:DisplayOrder>
      <d2p1:FriendlyName>sample string 2</d2p1:FriendlyName>
      <d2p1:IsMandatory>true</d2p1:IsMandatory>
      <d2p1:ParameterName>sample string 1</d2p1:ParameterName>
      <d2p1:PopulatorValues />
      <d2p1:ReportID>1</d2p1:ReportID>
      <d2p1:ReportParameterID>1</d2p1:ReportParameterID>
      <d2p1:ReportParameterTypeID>1</d2p1:ReportParameterTypeID>
      <d2p1:SelectedValue />
    </d2p1:ReportParameterModel>
  </ReportParameterList>
  <ReportTypeID>Standard_Report</ReportTypeID>
  <Report_ExportFormatID>MicrosoftWord</Report_ExportFormatID>
</ReportVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReportVM

Name	Type	Additional information
ReportID	integer	None.
ReportContent	Collection of byte	None.
ReportDisplayName	string	None.
ReportTypeID	ReportTypeID	None.
ReportParameterList	Collection of ReportParameterModel	None.
Report_ExportFormatID	Report_ExportFormatID	None.
Response	IResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "ReportID": 1,
  "ReportContent": "QEA=",
  "ReportDisplayName": "sample string 1",
  "ReportTypeID": 1,
  "ReportParameterList": [
    {
      "ReportParameterID": 1,
      "ReportID": 1,
      "ReportParameterTypeID": 1,
      "ParameterName": "sample string 1",
      "FriendlyName": "sample string 2",
      "DisplayOrder": 1,
      "DataTypeID": 1,
      "IsMandatory": true,
      "SelectedValue": {},
      "PopulatorValues": {}
    },
    {
      "ReportParameterID": 1,
      "ReportID": 1,
      "ReportParameterTypeID": 1,
      "ParameterName": "sample string 1",
      "FriendlyName": "sample string 2",
      "DisplayOrder": 1,
      "DataTypeID": 1,
      "IsMandatory": true,
      "SelectedValue": {},
      "PopulatorValues": {}
    }
  ],
  "Report_ExportFormatID": 1,
  "Response": null
}

application/xml, text/xml

Sample:

<ReportVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Report">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <ReportContent>QEA=</ReportContent>
  <ReportDisplayName>sample string 1</ReportDisplayName>
  <ReportID>1</ReportID>
  <ReportParameterList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.ReportParameter">
    <d2p1:ReportParameterModel>
      <d2p1:DataTypeID>1</d2p1:DataTypeID>
      <d2p1:DisplayOrder>1</d2p1:DisplayOrder>
      <d2p1:FriendlyName>sample string 2</d2p1:FriendlyName>
      <d2p1:IsMandatory>true</d2p1:IsMandatory>
      <d2p1:ParameterName>sample string 1</d2p1:ParameterName>
      <d2p1:PopulatorValues />
      <d2p1:ReportID>1</d2p1:ReportID>
      <d2p1:ReportParameterID>1</d2p1:ReportParameterID>
      <d2p1:ReportParameterTypeID>1</d2p1:ReportParameterTypeID>
      <d2p1:SelectedValue />
    </d2p1:ReportParameterModel>
    <d2p1:ReportParameterModel>
      <d2p1:DataTypeID>1</d2p1:DataTypeID>
      <d2p1:DisplayOrder>1</d2p1:DisplayOrder>
      <d2p1:FriendlyName>sample string 2</d2p1:FriendlyName>
      <d2p1:IsMandatory>true</d2p1:IsMandatory>
      <d2p1:ParameterName>sample string 1</d2p1:ParameterName>
      <d2p1:PopulatorValues />
      <d2p1:ReportID>1</d2p1:ReportID>
      <d2p1:ReportParameterID>1</d2p1:ReportParameterID>
      <d2p1:ReportParameterTypeID>1</d2p1:ReportParameterTypeID>
      <d2p1:SelectedValue />
    </d2p1:ReportParameterModel>
  </ReportParameterList>
  <ReportTypeID>Standard_Report</ReportTypeID>
  <Report_ExportFormatID>MicrosoftWord</Report_ExportFormatID>
</ReportVM>