GET api/v1/reports

List of all reports

Requires authorization!

Requires scope ReportRead

Response Codes

200 – Successfully got report list
401 – User is not Authorized

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of all reports
List of all generated reports

ApiResultReportList

Name	Description	Type	Additional information
Count	Number of items returned	integer	Required Range: inclusive between 0 and 2147483647
Payload	The payload of the response. Type depends on the API request.	Collection of ReportItem	None.
Success	Indicates if the request was successfull or not. `true` if the request was handled successfully, `false` otherwise.	boolean	Required
Errors	Error(s) accociated with the API request.	Collection of ApiError	None.

Response Formats

application/json, text/json

Sample:

{
  "Count": 1,
  "Payload": [
    {
      "ReportId": "11795be7-c45d-4cb9-98bd-cc70fec5bc56",
      "CreatedOn": "2024-12-17T02:25:25.4366541+02:00",
      "GeneratedOn": "2024-12-17T02:25:25.4366541+02:00",
      "PeriodStart": "2024-12-17T02:25:25.4366541+02:00",
      "PeriodEnd": "2024-12-17T02:25:25.4366541+02:00",
      "ReportType": 1
    },
    {
      "ReportId": "11795be7-c45d-4cb9-98bd-cc70fec5bc56",
      "CreatedOn": "2024-12-17T02:25:25.4366541+02:00",
      "GeneratedOn": "2024-12-17T02:25:25.4366541+02:00",
      "PeriodStart": "2024-12-17T02:25:25.4366541+02:00",
      "PeriodEnd": "2024-12-17T02:25:25.4366541+02:00",
      "ReportType": 1
    }
  ],
  "Success": true,
  "Errors": [
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    },
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiResultReportList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sobralaen.Api.Models">
  <Errors>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
  </Errors>
  <Success>true</Success>
  <Payload>
    <ReportItem>
      <CreatedOn>2024-12-17T02:25:25.4366541+02:00</CreatedOn>
      <GeneratedOn>2024-12-17T02:25:25.4366541+02:00</GeneratedOn>
      <PeriodEnd>2024-12-17T02:25:25.4366541+02:00</PeriodEnd>
      <PeriodStart>2024-12-17T02:25:25.4366541+02:00</PeriodStart>
      <ReportId>11795be7-c45d-4cb9-98bd-cc70fec5bc56</ReportId>
      <ReportType>IncomeReport</ReportType>
    </ReportItem>
    <ReportItem>
      <CreatedOn>2024-12-17T02:25:25.4366541+02:00</CreatedOn>
      <GeneratedOn>2024-12-17T02:25:25.4366541+02:00</GeneratedOn>
      <PeriodEnd>2024-12-17T02:25:25.4366541+02:00</PeriodEnd>
      <PeriodStart>2024-12-17T02:25:25.4366541+02:00</PeriodStart>
      <ReportId>11795be7-c45d-4cb9-98bd-cc70fec5bc56</ReportId>
      <ReportType>IncomeReport</ReportType>
    </ReportItem>
  </Payload>
  <Count>1</Count>
</ApiResultReportList>