API introspection – List packages, resources and their interfaces

Found 6 resources

Resource class Smartarchivo\Controller\WasteManagement\Api\V1\ContainerDispatchesController of type CollectionController
No access control

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

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

Name Type Size Default Description Visible Mutable Nullable
Container VIRTUAL not set yes no yes
DispatchedDatetime TIMESTAMP not set yes no no
DispatchedBy VARCHAR 36 not set yes no no
DispatchedByName VIRTUAL not set yes no yes
DispatchedActivity FLOAT not set yes no no
DispatchedComment VARCHAR 512 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\WasteManagement\Api\V1\ContainerDispatchesController

Resource: ContainerDispatches, Method: find

Loads a model collection or throws an exception

Endpoint
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatches/
Example request 
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatches
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:34 +0000
Content-Length: 1731
Content-Type: application/json
{
    "ContainerDispatchModelCollection": [
        {
            "Container": null,
            "DispatchedDatetime": "2013-11-12 16:39:00",
            "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
            "DispatchedByName": null,
            "DispatchedActivity": 3.1415926535898,
            "DispatchedComment": "Some comment",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ContainerDispatchModelCollection",
        "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
        }
    ]
}
Response data
FilteredContainerDispatchesControllerModel[] named ContainerDispatchModelCollection

Resource: ContainerDispatches, 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 /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatches/page/{?page}/
Example request 
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatches/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:34 +0000
Content-Length: 1731
Content-Type: application/json
{
    "ContainerDispatchModelCollection": [
        {
            "Container": null,
            "DispatchedDatetime": "2013-11-12 16:39:00",
            "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
            "DispatchedByName": null,
            "DispatchedActivity": 3.1415926535898,
            "DispatchedComment": "Some comment",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ContainerDispatchModelCollection",
        "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
        }
    ]
}
Response data
FilteredContainerDispatchesControllerModel[] named ContainerDispatchModelCollection