API introspection – List packages, resources and their interfaces

Found 4 resources

Resource class Smartarchivo\Controller\Generator\Api\V1\GeneratorsController of type CollectionController
No access control

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

Controller providing generator 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
Name VARCHAR 128 not set yes no no
State ENUM ACTIVE Value set: ACTIVE, DISPATCHED yes no no
Isotope ENUM MOLYBDENUM_99_MO Value set: MOLYBDENUM_99_MO, GERMANIUM_68_GE yes no no
Manufacturer VARCHAR 128 not set yes no no
BatchNumber VARCHAR 64 not set yes no no
SerialNumber VARCHAR 64 not set yes no no
DeliveryDate DATE not set yes no no
CalibrationDatetime TIMESTAMP not set yes no no
ActivityUnit ENUM MEGA_BEQUEREL Value set: MEGA_BEQUEREL, GIGA_BEQUEREL yes no no
NominalActivity FLOAT not set yes no no
AcceptedBy VARCHAR 36 not set yes no no
AcceptedByName VIRTUAL not set yes no yes
CurrentActivity VIRTUAL not set yes no yes
DispatchDatetime TIMESTAMP not set yes no yes
DispatchedBy VARCHAR 36 not set yes no yes
DispatchedActivity FLOAT not set yes no yes
DispatchedSurfaceContamination FLOAT not set yes no yes
DispatchedDoseRate FLOAT not set yes no yes
DispatchedByName 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\Generator\Api\V1\GeneratorsController

Resource: Generators, Method: find

Loads a model collection or throws an exception

Endpoint
GET /generator/api/v1/{clientUuid}/{facilityUuid}/generators/
Example request 
GET /generator/api/v1/{clientUuid}/{facilityUuid}/generators
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: 2448
Content-Type: application/json
{
    "GeneratorModelCollection": [
        {
            "Client": "123e4567-e89b-12d3-a456-426655440000",
            "Facility": "123e4567-e89b-12d3-a456-426655440000",
            "Name": "Generator 5000",
            "State": "ACTIVE",
            "Isotope": "MOLYBDENUM_99_MO",
            "Manufacturer": "ACME inc",
            "BatchNumber": "123abc-3654987",
            "SerialNumber": "3654987-123abc",
            "DeliveryDate": "2013-11-12",
            "CalibrationDatetime": "2013-11-12 16:39:00",
            "ActivityUnit": "MEGA_BEQUEREL",
            "NominalActivity": 3.1415926535898,
            "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
            "AcceptedByName": null,
            "CurrentActivity": null,
            "DispatchDatetime": "2013-11-12 16:39:00",
            "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
            "DispatchedActivity": 3.1415926535898,
            "DispatchedSurfaceContamination": 3.1415926535898,
            "DispatchedDoseRate": 3.1415926535898,
            "DispatchedByName": null,
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "GeneratorModelCollection",
        "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
FilteredGeneratorsControllerModel[] named GeneratorModelCollection

Resource: Generators, 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 /generator/api/v1/{clientUuid}/{facilityUuid}/generators/page/{?page}/
Example request 
GET /generator/api/v1/{clientUuid}/{facilityUuid}/generators/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: 2448
Content-Type: application/json
{
    "GeneratorModelCollection": [
        {
            "Client": "123e4567-e89b-12d3-a456-426655440000",
            "Facility": "123e4567-e89b-12d3-a456-426655440000",
            "Name": "Generator 5000",
            "State": "ACTIVE",
            "Isotope": "MOLYBDENUM_99_MO",
            "Manufacturer": "ACME inc",
            "BatchNumber": "123abc-3654987",
            "SerialNumber": "3654987-123abc",
            "DeliveryDate": "2013-11-12",
            "CalibrationDatetime": "2013-11-12 16:39:00",
            "ActivityUnit": "MEGA_BEQUEREL",
            "NominalActivity": 3.1415926535898,
            "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
            "AcceptedByName": null,
            "CurrentActivity": null,
            "DispatchDatetime": "2013-11-12 16:39:00",
            "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
            "DispatchedActivity": 3.1415926535898,
            "DispatchedSurfaceContamination": 3.1415926535898,
            "DispatchedDoseRate": 3.1415926535898,
            "DispatchedByName": null,
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "GeneratorModelCollection",
        "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
FilteredGeneratorsControllerModel[] named GeneratorModelCollection