API introspection – List packages, resources and their interfaces

Found 6 resources

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

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

Controller providing container related actions.

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 yes no
Name VARCHAR 128 not set yes yes no
Weight FLOAT not set yes yes yes
MeasurementActivity FLOAT not set yes yes yes
MeasurementFactor FLOAT not set yes yes yes
MeasurementDate TIMESTAMP not set yes yes yes
MeasuredBy VARCHAR 36 not set yes yes yes
MeasuredByName VIRTUAL not set yes no yes
CurrentSpecificActivity VIRTUAL not set yes no yes
MeasurementContamination FLOAT not set yes yes yes
MeasurementContaminationDateTime TIMESTAMP not set yes yes yes
MeasurementContaminationBy VARCHAR 36 not set yes yes yes
MeasurementContaminationByName VIRTUAL not set yes no yes
ReleaseDateTime TIMESTAMP not set yes yes yes
IsReleasedByRadiationProtectionOfficer BOOLEAN not set yes yes yes
ReleasedByRadiationProtectionOfficerDateTime TIMESTAMP not set yes yes yes
ReleasedByRadiationProtectionOfficer VARCHAR 36 not set yes yes 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 5 interfaces in class Smartarchivo\Controller\WasteManagement\Api\V1\ContainerController

Resource: Container, Method: load

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

Endpoint
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container/{uuid}/
Example request 
GET /waste-management/api/v1/{clientUuid}/{facilityUuid}/container/{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: 1902
Content-Type: application/json
{
    "ContainerModel": {
        "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"
    },
    "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 ContainerModel

Resource: Container, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 1902
Content-Type: application/json
{
    "ContainerModel": {
        "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"
    },
    "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 ContainerModel

Resource: Container, Method: create

Creates model with properties given by request

Endpoint
POST /waste-management/api/v1/{clientUuid}/{facilityUuid}/container/
Example request 
POST /waste-management/api/v1/{clientUuid}/{facilityUuid}/container
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 717
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "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",
    "MeasurementContamination": 3.1415926535898,
    "MeasurementContaminationDateTime": "2013-11-12 16:39:00",
    "MeasurementContaminationBy": "123e4567-e89b-12d3-a456-426655440000",
    "ReleaseDateTime": "2013-11-12 16:39:00",
    "IsReleasedByRadiationProtectionOfficer": true,
    "ReleasedByRadiationProtectionOfficerDateTime": "2013-11-12 16:39:00",
    "ReleasedByRadiationProtectionOfficer": "123e4567-e89b-12d3-a456-426655440000"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 1902
Content-Type: application/json
{
    "ContainerModel": {
        "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"
    },
    "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
FilteredContainerControllerModel
Response data
FilteredContainerControllerModel named ContainerModel

Resource: Container, Method: update

Updates model with properties given by request

Endpoint
PUT /waste-management/api/v1/{clientUuid}/{facilityUuid}/container/{Uuid}/
Example request 
PUT /waste-management/api/v1/{clientUuid}/{facilityUuid}/container/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 717
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "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",
    "MeasurementContamination": 3.1415926535898,
    "MeasurementContaminationDateTime": "2013-11-12 16:39:00",
    "MeasurementContaminationBy": "123e4567-e89b-12d3-a456-426655440000",
    "ReleaseDateTime": "2013-11-12 16:39:00",
    "IsReleasedByRadiationProtectionOfficer": true,
    "ReleasedByRadiationProtectionOfficerDateTime": "2013-11-12 16:39:00",
    "ReleasedByRadiationProtectionOfficer": "123e4567-e89b-12d3-a456-426655440000"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 1902
Content-Type: application/json
{
    "ContainerModel": {
        "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"
    },
    "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
FilteredContainerControllerModel
Response data
FilteredContainerControllerModel named ContainerModel

Resource: Container, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 1902
Content-Type: application/json
{
    "ContainerModel": {
        "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"
    },
    "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 ContainerModel