API introspection – List packages, resources and their interfaces

Found 6 resources

Resource class Smartarchivo\Controller\WasteManagement\Api\V1\ContainerDispatchController of type EntityController
No access control

Skeleton class for controlling a row from the 'ContainerDispatchModel' table.

Controller providing container dispatch related actions.

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

Resource: ContainerDispatch, Method: load

Loads a model enitiy from the table defined by the model class name

Endpoint
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatch/{uuid}/
Example request 
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatch/{uuid}
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: 1024
Content-Type: application/json
{
    "ContainerDispatchModel": {
        "Container": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedByName": "Jane Doe",
        "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"
    },
    "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
FilteredContainerControllerModel named ContainerDispatchModel

Resource: ContainerDispatch, Method: loadDefault

Loads an item holding the default attributes

Endpoint
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatch/
Example request 
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatch
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 1024
Content-Type: application/json
{
    "ContainerDispatchModel": {
        "Container": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedByName": "Jane Doe",
        "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"
    },
    "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
FilteredContainerDispatchControllerModel named ContainerDispatchModel

Resource: ContainerDispatch, Method: create

Creates model with properties given by request

Endpoint
POST /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatch/
Example request 
POST /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatch
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 252
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "DispatchedDatetime": "2013-11-12 16:39:00",
    "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
    "DispatchedActivity": 3.1415926535898,
    "DispatchedComment": "Some comment",
    "Container": "123e4567-e89b-12d3-a456-426655440000"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 1024
Content-Type: application/json
{
    "ContainerDispatchModel": {
        "Container": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedByName": "Jane Doe",
        "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"
    },
    "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 data
FilteredContainerDispatchControllerModel
Response data
FilteredContainerDispatchControllerModel named ContainerDispatchModel

Resource: ContainerDispatch, Method: delete

Deletes the loaded model

Endpoint
DELETE /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatch/{Uuid}/
Example request 
DELETE /waste-management/api/v1/{clientUuid}/{facilityUuid}/container-dispatch/{Uuid}
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 1024
Content-Type: application/json
{
    "ContainerDispatchModel": {
        "Container": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedByName": "Jane Doe",
        "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"
    },
    "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
FilteredContainerDispatchControllerModel named ContainerDispatchModel