API introspection – List packages, resources and their interfaces

Found 2 resources

Resource class Awo\ContentVendor\Extension\Training\Controller\Api\V1\TrainingsController of type CollectionController
Access controlled by ContentVendor\Core\Api\AccessRule\ApiAccessRule

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

Controller providing training collection related actions.

Name Type Size Default Description Visible Mutable Nullable
Uuid VARCHAR 36 not set yes no no
PreetzTeamContactPerson VIRTUAL not set yes no yes
ElmshornTeamContactPerson VIRTUAL not set yes no yes
LauenburgTeamContactPerson VIRTUAL not set yes no yes
Title VARCHAR 128 not set yes no no
WorkingHours ENUM not set Value set: PART_TIME, FULL_TIME yes no no
Locations SET not set yes no no
PrimaryPdfDocumentTitle VARCHAR 36 not set yes no yes
SecondaryPdfDocumentTitle VARCHAR 36 not set yes no yes
TertiaryPdfDocumentTitle VARCHAR 36 not set yes no yes
PrimaryPdfDocumentUrl VIRTUAL not set yes no yes
SecondaryPdfDocumentUrl VIRTUAL not set yes no yes
TertiaryPdfDocumentUrl VIRTUAL not set yes no yes
ResultPrimaryPdfDocumentTitle VARCHAR 36 not set yes no yes
ResultSecondaryPdfDocumentTitle VARCHAR 36 not set yes no yes
ResultTertiaryPdfDocumentTitle VARCHAR 36 not set yes no yes
ResultPrimaryPdfDocumentUrl VIRTUAL not set yes no yes
ResultSecondaryPdfDocumentUrl VIRTUAL not set yes no yes
ResultTertiaryPdfDocumentUrl VIRTUAL not set yes no yes

Interfaces

Found 2 interfaces in class Awo\ContentVendor\Extension\Training\Controller\Api\V1\TrainingsController

Resource: Trainings, Method: find

Loads a model collection or throws an exception

Endpoint
GET /training-extension/api/v1/trainings/
Example request 
GET /training-extension/api/v1/trainings
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 31 Mar 2020 16:29:06 +0000
Content-Length: 2240
Content-Type: application/json
{
    "AwoTrainingModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "PreetzTeamContactPerson": null,
            "ElmshornTeamContactPerson": null,
            "LauenburgTeamContactPerson": null,
            "Title": "Reklamationsmanagement",
            "WorkingHours": "PART_TIME",
            "Locations": "PREETZ",
            "PrimaryPdfDocumentTitle": "EU Richtlinien",
            "SecondaryPdfDocumentTitle": "EU Richtlinien",
            "TertiaryPdfDocumentTitle": "EU Richtlinien",
            "PrimaryPdfDocumentUrl": null,
            "SecondaryPdfDocumentUrl": null,
            "TertiaryPdfDocumentUrl": null,
            "ResultPrimaryPdfDocumentTitle": "EU Richtlinien",
            "ResultSecondaryPdfDocumentTitle": "EU Richtlinien",
            "ResultTertiaryPdfDocumentTitle": "EU Richtlinien",
            "ResultPrimaryPdfDocumentUrl": null,
            "ResultSecondaryPdfDocumentUrl": null,
            "ResultTertiaryPdfDocumentUrl": null
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoTrainingModelCollection",
        "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
        }
    ]
}
GET /training-extension/api/v1/trainings
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Tue, 31 Mar 2020 16:29:06 +0000                      

                      Content-Length: 2240                      

                      Content-Type: application/json
                                              

                        {
    "AwoTrainingModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "PreetzTeamContactPerson": null,
            "ElmshornTeamContactPerson": null,
            "LauenburgTeamContactPerson": null,
            "Title": "Reklamationsmanagement",
            "WorkingHours": "PART_TIME",
            "Locations": "PREETZ",
            "PrimaryPdfDocumentTitle": "EU Richtlinien",
            "SecondaryPdfDocumentTitle": "EU Richtlinien",
            "TertiaryPdfDocumentTitle": "EU Richtlinien",
            "PrimaryPdfDocumentUrl": null,
            "SecondaryPdfDocumentUrl": null,
            "TertiaryPdfDocumentUrl": null,
            "ResultPrimaryPdfDocumentTitle": "EU Richtlinien",
            "ResultSecondaryPdfDocumentTitle": "EU Richtlinien",
            "ResultTertiaryPdfDocumentTitle": "EU Richtlinien",
            "ResultPrimaryPdfDocumentUrl": null,
            "ResultSecondaryPdfDocumentUrl": null,
            "ResultTertiaryPdfDocumentUrl": null
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoTrainingModelCollection",
        "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
FilteredTrainingsControllerModel[] named AwoTrainingModelCollection

Resource: Trainings, Method: page

Loads an paginated model collection or throws an exception

The number of items per page is defined in the class property $modelsPerPage

Endpoint
GET /training-extension/api/v1/trainings/page/{?page}/
Example request 
GET /training-extension/api/v1/trainings/page/{?page}
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 31 Mar 2020 16:29:06 +0000
Content-Length: 2240
Content-Type: application/json
{
    "AwoTrainingModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "PreetzTeamContactPerson": null,
            "ElmshornTeamContactPerson": null,
            "LauenburgTeamContactPerson": null,
            "Title": "Reklamationsmanagement",
            "WorkingHours": "PART_TIME",
            "Locations": "PREETZ",
            "PrimaryPdfDocumentTitle": "EU Richtlinien",
            "SecondaryPdfDocumentTitle": "EU Richtlinien",
            "TertiaryPdfDocumentTitle": "EU Richtlinien",
            "PrimaryPdfDocumentUrl": null,
            "SecondaryPdfDocumentUrl": null,
            "TertiaryPdfDocumentUrl": null,
            "ResultPrimaryPdfDocumentTitle": "EU Richtlinien",
            "ResultSecondaryPdfDocumentTitle": "EU Richtlinien",
            "ResultTertiaryPdfDocumentTitle": "EU Richtlinien",
            "ResultPrimaryPdfDocumentUrl": null,
            "ResultSecondaryPdfDocumentUrl": null,
            "ResultTertiaryPdfDocumentUrl": null
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoTrainingModelCollection",
        "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
        }
    ]
}
GET /training-extension/api/v1/trainings/page/{?page}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Tue, 31 Mar 2020 16:29:06 +0000                      

                      Content-Length: 2240                      

                      Content-Type: application/json
                                              

                        {
    "AwoTrainingModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "PreetzTeamContactPerson": null,
            "ElmshornTeamContactPerson": null,
            "LauenburgTeamContactPerson": null,
            "Title": "Reklamationsmanagement",
            "WorkingHours": "PART_TIME",
            "Locations": "PREETZ",
            "PrimaryPdfDocumentTitle": "EU Richtlinien",
            "SecondaryPdfDocumentTitle": "EU Richtlinien",
            "TertiaryPdfDocumentTitle": "EU Richtlinien",
            "PrimaryPdfDocumentUrl": null,
            "SecondaryPdfDocumentUrl": null,
            "TertiaryPdfDocumentUrl": null,
            "ResultPrimaryPdfDocumentTitle": "EU Richtlinien",
            "ResultSecondaryPdfDocumentTitle": "EU Richtlinien",
            "ResultTertiaryPdfDocumentTitle": "EU Richtlinien",
            "ResultPrimaryPdfDocumentUrl": null,
            "ResultSecondaryPdfDocumentUrl": null,
            "ResultTertiaryPdfDocumentUrl": null
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoTrainingModelCollection",
        "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
FilteredTrainingsControllerModel[] named AwoTrainingModelCollection