GET api/GetReportFavouritesByUserID/{userID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userID

integer

Required

Body Parameters

None.

Response Information

Resource Description

PMAReportFavourites
NameDescriptionTypeAdditional information
PMAReportFavouritesList

Collection of PMAReportFavouriteData

None.

FavouriteType

integer

None.

TotalReportsList

Collection of PMATotalReportsList

None.

Response Formats

application/json, text/json

Sample:
{
  "PMAReportFavouritesList": [
    {
      "ReportName": "sample string 1",
      "ReportFavouriteID": "sample string 2"
    },
    {
      "ReportName": "sample string 1",
      "ReportFavouriteID": "sample string 2"
    }
  ],
  "FavouriteType": 1,
  "TotalReportsList": [
    {
      "ReportID": 1,
      "ReportDivID": "sample string 2"
    },
    {
      "ReportID": 1,
      "ReportDivID": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<PMAReportFavourites xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Goaa.iPro.Data.Admin.CustomClasses">
  <FavouriteType>1</FavouriteType>
  <PMAReportFavouritesList>
    <PMAReportFavouriteData>
      <ReportFavouriteID>sample string 2</ReportFavouriteID>
      <ReportName>sample string 1</ReportName>
    </PMAReportFavouriteData>
    <PMAReportFavouriteData>
      <ReportFavouriteID>sample string 2</ReportFavouriteID>
      <ReportName>sample string 1</ReportName>
    </PMAReportFavouriteData>
  </PMAReportFavouritesList>
  <TotalReportsList>
    <PMATotalReportsList>
      <ReportDivID>sample string 2</ReportDivID>
      <ReportID>1</ReportID>
    </PMATotalReportsList>
    <PMATotalReportsList>
      <ReportDivID>sample string 2</ReportDivID>
      <ReportID>1</ReportID>
    </PMATotalReportsList>
  </TotalReportsList>
</PMAReportFavourites>