API introspection – List packages, resources and their interfaces

Found 2 resources

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

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

Controller providing training related actions.

Name Type Size Default Description Visible Mutable Nullable
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
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 3 interfaces in class Awo\ContentVendor\Extension\Training\Controller\Api\V1\TrainingController

Resource: Training, Method: pdfDocument

Provides the PDF document as binary if available or creates a not found response

Endpoint
GET /training-extension/api/v1/training/{uuid}/pdf-document/{which}/
Request header
Bearer Token named Authorization

Resource: Training, Method: resultPdfDocument

Provides the PDF document as binary if available or creates a not found response

Endpoint
GET /training-extension/api/v1/training/{uuid}/result-pdf-document/{which}/
Request header
Bearer Token named Authorization

Resource: Training, Method: load

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

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

HTTP/1.1 200 Ok
Date: Tue, 31 Mar 2020 16:29:06 +0000
Content-Length: 3853
Content-Type: application/json
{
    "AwoTrainingModel": {
        "Uuid": "123e4567-e89b-12d3-a456-426655440000",
        "PreetzTeamContactPerson": {
            "Department": "ADMINISTRATION",
            "Fullname": "Petra Schmidt",
            "Position": "Gesundheits- und Krankenpflegerin",
            "PortraitUrl": "\/team-extension\/api\/v1\/contact-person\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/portrait\/",
            "PhoneNumber": "+49 431 - 2400666",
            "MailAddress": "service@awo-bildungscampus.de",
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "Description": "",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "ElmshornTeamContactPerson": {
            "Department": "ADMINISTRATION",
            "Fullname": "Petra Schmidt",
            "Position": "Gesundheits- und Krankenpflegerin",
            "PortraitUrl": "\/team-extension\/api\/v1\/contact-person\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/portrait\/",
            "PhoneNumber": "+49 431 - 2400666",
            "MailAddress": "service@awo-bildungscampus.de",
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "Description": "",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "LauenburgTeamContactPerson": {
            "Department": "ADMINISTRATION",
            "Fullname": "Petra Schmidt",
            "Position": "Gesundheits- und Krankenpflegerin",
            "PortraitUrl": "\/team-extension\/api\/v1\/contact-person\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/portrait\/",
            "PhoneNumber": "+49 431 - 2400666",
            "MailAddress": "service@awo-bildungscampus.de",
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "Description": "",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "Title": "Reklamationsmanagement",
        "WorkingHours": "PART_TIME",
        "Locations": "PREETZ",
        "PrimaryPdfDocumentTitle": "EU Richtlinien",
        "SecondaryPdfDocumentTitle": "EU Richtlinien",
        "TertiaryPdfDocumentTitle": "EU Richtlinien",
        "PrimaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/primary",
        "SecondaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/secondary",
        "TertiaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/tertiary",
        "ResultPrimaryPdfDocumentTitle": "EU Richtlinien",
        "ResultSecondaryPdfDocumentTitle": "EU Richtlinien",
        "ResultTertiaryPdfDocumentTitle": "EU Richtlinien",
        "ResultPrimaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/result-pdf-document\/primary",
        "ResultSecondaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/result-pdf-document\/secondary",
        "ResultTertiaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/result-pdf-document\/tertiary"
    },
    "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/training/{uuid}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

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

                      Content-Length: 3853                      

                      Content-Type: application/json
                                              

                        {
    "AwoTrainingModel": {
        "Uuid": "123e4567-e89b-12d3-a456-426655440000",
        "PreetzTeamContactPerson": {
            "Department": "ADMINISTRATION",
            "Fullname": "Petra Schmidt",
            "Position": "Gesundheits- und Krankenpflegerin",
            "PortraitUrl": "\/team-extension\/api\/v1\/contact-person\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/portrait\/",
            "PhoneNumber": "+49 431 - 2400666",
            "MailAddress": "service@awo-bildungscampus.de",
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "Description": "",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "ElmshornTeamContactPerson": {
            "Department": "ADMINISTRATION",
            "Fullname": "Petra Schmidt",
            "Position": "Gesundheits- und Krankenpflegerin",
            "PortraitUrl": "\/team-extension\/api\/v1\/contact-person\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/portrait\/",
            "PhoneNumber": "+49 431 - 2400666",
            "MailAddress": "service@awo-bildungscampus.de",
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "Description": "",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "LauenburgTeamContactPerson": {
            "Department": "ADMINISTRATION",
            "Fullname": "Petra Schmidt",
            "Position": "Gesundheits- und Krankenpflegerin",
            "PortraitUrl": "\/team-extension\/api\/v1\/contact-person\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/portrait\/",
            "PhoneNumber": "+49 431 - 2400666",
            "MailAddress": "service@awo-bildungscampus.de",
            "AddressStreet": "Musterstrasse 123",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "Description": "",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "Title": "Reklamationsmanagement",
        "WorkingHours": "PART_TIME",
        "Locations": "PREETZ",
        "PrimaryPdfDocumentTitle": "EU Richtlinien",
        "SecondaryPdfDocumentTitle": "EU Richtlinien",
        "TertiaryPdfDocumentTitle": "EU Richtlinien",
        "PrimaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/primary",
        "SecondaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/secondary",
        "TertiaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/tertiary",
        "ResultPrimaryPdfDocumentTitle": "EU Richtlinien",
        "ResultSecondaryPdfDocumentTitle": "EU Richtlinien",
        "ResultTertiaryPdfDocumentTitle": "EU Richtlinien",
        "ResultPrimaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/result-pdf-document\/primary",
        "ResultSecondaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/result-pdf-document\/secondary",
        "ResultTertiaryPdfDocumentUrl": "\/training-extension\/api\/v1\/training\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/result-pdf-document\/tertiary"
    },
    "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
FilteredTrainingControllerModel named AwoTrainingModel