GET api/v1/report/{id}

Get report data for specified report identificator.

Requires authorization!

Requires scope ReportRead

Response Codes

200 – Successfully got report data
401 – User is not Authorized
403 – Not allowed to get the Report, because the Report is not owned by current user
404 – Report with specified identificator was not found
409 – Report type is not supported

Request Information

URI Parameters

Name	Description	Type	Additional information
id	ReportId	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Get report data for specified report identificator.
Report data, depends on the report's ReportType

ApiResultReport

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.	Report	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": {
    "Result": [
      {},
      {}
    ],
    "ReportId": "dba16df9-f303-48e1-975c-defbcc4b3773",
    "CreatedOn": "2024-04-24T23:43:05.4691802+03:00",
    "GeneratedOn": "2024-04-24T23:43:05.4691802+03:00",
    "PeriodStart": "2024-04-24T23:43:05.4691802+03:00",
    "PeriodEnd": "2024-04-24T23:43:05.4691802+03: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:

<ApiResultReport 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>
    <CreatedOn>2024-04-24T23:43:05.4691802+03:00</CreatedOn>
    <GeneratedOn>2024-04-24T23:43:05.4691802+03:00</GeneratedOn>
    <PeriodEnd>2024-04-24T23:43:05.4691802+03:00</PeriodEnd>
    <PeriodStart>2024-04-24T23:43:05.4691802+03:00</PeriodStart>
    <ReportId>dba16df9-f303-48e1-975c-defbcc4b3773</ReportId>
    <ReportType>IncomeReport</ReportType>
    <Result xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </Result>
  </Payload>
  <Count>1</Count>
</ApiResultReport>