API introspection – List packages, resources and their interfaces

Found 6 resources

Resource class Smartarchivo\Controller\Report\Api\V1\ReportsController of type CollectionController
No access control

Skeleton class for controlling a collection of rows from the 'ReportModel' table.

Controller providing report related collection actions like listing, filtering, searching and others.

Name Type Size Default Description Visible Mutable Nullable
Name VARCHAR 128 not set yes no no
PeriodDateStart DATE not set yes no no
PeriodDateEnd DATE not set yes no no
ValidUntil DATE not set yes no no
ClientName VIRTUAL not set yes no yes
FacilityName VIRTUAL not set yes no yes
ReportSequences VIRTUAL not set yes no yes
ReportDocuments VIRTUAL not set yes no yes
CreatedAt TIMESTAMP not set yes no yes
UpdatedAt TIMESTAMP not set yes no yes
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 2 interfaces in class Smartarchivo\Controller\Report\Api\V1\ReportsController

Resource: Reports, Method: find

Loads a model collection or throws an exception

Endpoint
GET /report/api/v1/{clientUuid}/{facilityUuid}/reports/
Example request 
GET /report/api/v1/{clientUuid}/{facilityUuid}/reports
Host: /
Accept: application/json
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 2564
Content-Type: application/json
{
    "ReportModelCollection": [
        {
            "Name": "CT-Report 2021-12",
            "PeriodDateStart": "2013-11-12",
            "PeriodDateEnd": "2013-11-12",
            "ValidUntil": "2013-11-12",
            "ClientName": null,
            "FacilityName": null,
            "ReportSequences": [
                {
                    "Report": "123e4567-e89b-12d3-a456-426655440000",
                    "Sequence": "123e4567-e89b-12d3-a456-426655440000",
                    "PeriodDateStart": "2013-11-12",
                    "PeriodDateEnd": "2013-11-12",
                    "CreatedAt": "2013-11-12 16:39:00",
                    "UpdatedAt": "2013-11-12 16:39:00",
                    "Uuid": "123e4567-e89b-12d3-a456-426655440000"
                }
            ],
            "ReportDocuments": [
                {
                    "Report": "123e4567-e89b-12d3-a456-426655440000",
                    "Document": "123e4567-e89b-12d3-a456-426655440000",
                    "CreatedAt": "2013-11-12 16:39:00",
                    "UpdatedAt": "2013-11-12 16:39:00",
                    "Uuid": "123e4567-e89b-12d3-a456-426655440000"
                }
            ],
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ReportModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredReportsControllerModel[] named ReportModelCollection

Resource: Reports, Method: page

Loads a paginated model collection or throws an exception

The number of items per page is defined in the class property $modelsPerPage

Endpoint
GET /report/api/v1/{clientUuid}/{facilityUuid}/reports/page/{?page}/
Example request 
GET /report/api/v1/{clientUuid}/{facilityUuid}/reports/page/{?page}
Host: /
Accept: application/json
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 2564
Content-Type: application/json
{
    "ReportModelCollection": [
        {
            "Name": "CT-Report 2021-12",
            "PeriodDateStart": "2013-11-12",
            "PeriodDateEnd": "2013-11-12",
            "ValidUntil": "2013-11-12",
            "ClientName": null,
            "FacilityName": null,
            "ReportSequences": [
                {
                    "Report": "123e4567-e89b-12d3-a456-426655440000",
                    "Sequence": "123e4567-e89b-12d3-a456-426655440000",
                    "PeriodDateStart": "2013-11-12",
                    "PeriodDateEnd": "2013-11-12",
                    "CreatedAt": "2013-11-12 16:39:00",
                    "UpdatedAt": "2013-11-12 16:39:00",
                    "Uuid": "123e4567-e89b-12d3-a456-426655440000"
                }
            ],
            "ReportDocuments": [
                {
                    "Report": "123e4567-e89b-12d3-a456-426655440000",
                    "Document": "123e4567-e89b-12d3-a456-426655440000",
                    "CreatedAt": "2013-11-12 16:39:00",
                    "UpdatedAt": "2013-11-12 16:39:00",
                    "Uuid": "123e4567-e89b-12d3-a456-426655440000"
                }
            ],
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ReportModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredReportsControllerModel[] named ReportModelCollection