API introspection – List packages, resources and their interfaces

Found 2 resources

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

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

Controller providing course collection related actions.

Name Type Size Default Description Visible Mutable Nullable
Uuid VARCHAR 36 not set yes no no
State ENUM OPEN Value set: OPEN, FULLY_BOOKED, CANCELLED yes no no
Internal BOOLEAN yes no no
InternalPassword VARCHAR 24 not set yes no yes
Topics ARRAY not set yes no no
TeamContactPerson VIRTUAL not set yes no yes
Title VARCHAR 128 not set yes no no
Subtitle VARCHAR 128 not set yes no yes
PdfDocumentUrl VIRTUAL not set yes no yes
DateStart DATE not set yes no no
DateEnd DATE not set yes no yes
Duration INTEGER not set yes no yes
AddressStreet VARCHAR 128 not set yes no no
AddressZip VARCHAR 5 not set yes no no
AddressCity VARCHAR 64 not set yes no no
AddressGeolocationLongitude FLOAT not set yes no no
AddressGeolocationLatitude FLOAT not set yes no no

Interfaces

Found 2 interfaces in class Awo\ContentVendor\Extension\Course\Controller\Api\V1\CoursesController

Resource: Courses, Method: find

Loads a model collection or throws an exception

Endpoint
GET /course-extension/api/v1/courses/
Example request 
GET /course-extension/api/v1/courses
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 10 Nov 2020 08:47:35 +0000
Content-Length: 2133
Content-Type: application/json
{
    "AwoCourseOfferModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "State": "OPEN",
            "Internal": true,
            "InternalPassword": "Some password required for applying to the course",
            "Topics": [
                "Demenz",
                "Entbürokratisierung",
                "Ernährung"
            ],
            "TeamContactPerson": null,
            "Title": "Reklamationsmanagement",
            "Subtitle": "Some descriptive subtitle",
            "PdfDocumentUrl": null,
            "DateStart": "2013-11-12",
            "DateEnd": "2013-11-12",
            "Duration": 4096,
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "AddressGeolocationLongitude": 3.1415926535898,
            "AddressGeolocationLatitude": 3.1415926535898
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoCourseOfferModelCollection",
        "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 /course-extension/api/v1/courses
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Tue, 10 Nov 2020 08:47:35 +0000                      

                      Content-Length: 2133                      

                      Content-Type: application/json
                                              

                        {
    "AwoCourseOfferModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "State": "OPEN",
            "Internal": true,
            "InternalPassword": "Some password required for applying to the course",
            "Topics": [
                "Demenz",
                "Entbürokratisierung",
                "Ernährung"
            ],
            "TeamContactPerson": null,
            "Title": "Reklamationsmanagement",
            "Subtitle": "Some descriptive subtitle",
            "PdfDocumentUrl": null,
            "DateStart": "2013-11-12",
            "DateEnd": "2013-11-12",
            "Duration": 4096,
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "AddressGeolocationLongitude": 3.1415926535898,
            "AddressGeolocationLatitude": 3.1415926535898
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoCourseOfferModelCollection",
        "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 Token named Authorization
Response data
FilteredCoursesControllerModel[] named AwoCourseOfferModelCollection

Resource: Courses, 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 /course-extension/api/v1/courses/page/{?page}/
Example request 
GET /course-extension/api/v1/courses/page/{?page}
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 10 Nov 2020 08:47:35 +0000
Content-Length: 2133
Content-Type: application/json
{
    "AwoCourseOfferModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "State": "OPEN",
            "Internal": true,
            "InternalPassword": "Some password required for applying to the course",
            "Topics": [
                "Demenz",
                "Entbürokratisierung",
                "Ernährung"
            ],
            "TeamContactPerson": null,
            "Title": "Reklamationsmanagement",
            "Subtitle": "Some descriptive subtitle",
            "PdfDocumentUrl": null,
            "DateStart": "2013-11-12",
            "DateEnd": "2013-11-12",
            "Duration": 4096,
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "AddressGeolocationLongitude": 3.1415926535898,
            "AddressGeolocationLatitude": 3.1415926535898
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoCourseOfferModelCollection",
        "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 /course-extension/api/v1/courses/page/{?page}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Tue, 10 Nov 2020 08:47:35 +0000                      

                      Content-Length: 2133                      

                      Content-Type: application/json
                                              

                        {
    "AwoCourseOfferModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "State": "OPEN",
            "Internal": true,
            "InternalPassword": "Some password required for applying to the course",
            "Topics": [
                "Demenz",
                "Entbürokratisierung",
                "Ernährung"
            ],
            "TeamContactPerson": null,
            "Title": "Reklamationsmanagement",
            "Subtitle": "Some descriptive subtitle",
            "PdfDocumentUrl": null,
            "DateStart": "2013-11-12",
            "DateEnd": "2013-11-12",
            "Duration": 4096,
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "AddressGeolocationLongitude": 3.1415926535898,
            "AddressGeolocationLatitude": 3.1415926535898
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoCourseOfferModelCollection",
        "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 Token named Authorization
Response data
FilteredCoursesControllerModel[] named AwoCourseOfferModelCollection