API introspection – List packages, resources and their interfaces

Found 6 resources

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

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

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

Name Type Size Default Description Visible Mutable Nullable
Client VARCHAR 36 not set yes no no
Facility VARCHAR 36 not set yes no no
State ENUM OPEN Value set: OPEN, DECAY, RELEASE_DATE_REACHED, DISPATCHED, DISPOSED yes no no
Name VARCHAR 128 not set yes no no
Weight FLOAT not set yes no yes
MeasurementActivity FLOAT not set yes no yes
MeasurementFactor FLOAT not set yes no yes
MeasurementDate TIMESTAMP not set yes no yes
MeasuredBy VARCHAR 36 not set yes no yes
MeasuredByName VIRTUAL not set yes no yes
CurrentSpecificActivity VIRTUAL not set yes no yes
MeasurementContamination FLOAT not set yes no yes
MeasurementContaminationDateTime TIMESTAMP not set yes no yes
MeasurementContaminationBy VARCHAR 36 not set yes no yes
MeasurementContaminationByName VIRTUAL not set yes no yes
ReleaseDateTime TIMESTAMP not set yes no yes
IsReleasedByRadiationProtectionOfficer BOOLEAN not set yes no yes
ReleasedByRadiationProtectionOfficerDateTime TIMESTAMP not set yes no yes
ReleasedByRadiationProtectionOfficer VARCHAR 36 not set yes no yes
ReleasedByRadiationProtectionOfficerName VIRTUAL not set yes no yes
DispatchId VIRTUAL not set yes no yes
DisposeId VIRTUAL not set yes no yes
CyclotroneProductIds VIRTUAL not set yes no yes
GeneratorEluatIds 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\WasteManagement\Api\V1\ContainersController

Resource: Containers, Method: find

Loads a model collection or throws an exception

Endpoint
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/containers/
Example request 
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/containers
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: 2713
Content-Type: application/json
{
    "ContainerModelCollection": [
        {
            "Client": "123e4567-e89b-12d3-a456-426655440000",
            "Facility": "123e4567-e89b-12d3-a456-426655440000",
            "State": "OPEN",
            "Name": "Container name",
            "Weight": 3.1415926535898,
            "MeasurementActivity": 3.1415926535898,
            "MeasurementFactor": 3.1415926535898,
            "MeasurementDate": "2013-11-12 16:39:00",
            "MeasuredBy": "123e4567-e89b-12d3-a456-426655440000",
            "MeasuredByName": null,
            "CurrentSpecificActivity": null,
            "MeasurementContamination": 3.1415926535898,
            "MeasurementContaminationDateTime": "2013-11-12 16:39:00",
            "MeasurementContaminationBy": "123e4567-e89b-12d3-a456-426655440000",
            "MeasurementContaminationByName": null,
            "ReleaseDateTime": "2013-11-12 16:39:00",
            "IsReleasedByRadiationProtectionOfficer": true,
            "ReleasedByRadiationProtectionOfficerDateTime": "2013-11-12 16:39:00",
            "ReleasedByRadiationProtectionOfficer": "123e4567-e89b-12d3-a456-426655440000",
            "ReleasedByRadiationProtectionOfficerName": null,
            "DispatchId": null,
            "DisposeId": null,
            "CyclotroneProductIds": null,
            "GeneratorEluatIds": null,
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ContainerModelCollection",
        "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
FilteredContainersControllerModel[] named ContainerModelCollection

Resource: Containers, 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}/containers/page/{?page}/
Example request 
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/containers/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: 2713
Content-Type: application/json
{
    "ContainerModelCollection": [
        {
            "Client": "123e4567-e89b-12d3-a456-426655440000",
            "Facility": "123e4567-e89b-12d3-a456-426655440000",
            "State": "OPEN",
            "Name": "Container name",
            "Weight": 3.1415926535898,
            "MeasurementActivity": 3.1415926535898,
            "MeasurementFactor": 3.1415926535898,
            "MeasurementDate": "2013-11-12 16:39:00",
            "MeasuredBy": "123e4567-e89b-12d3-a456-426655440000",
            "MeasuredByName": null,
            "CurrentSpecificActivity": null,
            "MeasurementContamination": 3.1415926535898,
            "MeasurementContaminationDateTime": "2013-11-12 16:39:00",
            "MeasurementContaminationBy": "123e4567-e89b-12d3-a456-426655440000",
            "MeasurementContaminationByName": null,
            "ReleaseDateTime": "2013-11-12 16:39:00",
            "IsReleasedByRadiationProtectionOfficer": true,
            "ReleasedByRadiationProtectionOfficerDateTime": "2013-11-12 16:39:00",
            "ReleasedByRadiationProtectionOfficer": "123e4567-e89b-12d3-a456-426655440000",
            "ReleasedByRadiationProtectionOfficerName": null,
            "DispatchId": null,
            "DisposeId": null,
            "CyclotroneProductIds": null,
            "GeneratorEluatIds": null,
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ContainerModelCollection",
        "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
FilteredContainersControllerModel[] named ContainerModelCollection