API introspection – List packages, resources and their interfaces

Found 1 resources

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

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

Controller providing project related actions.

Name Type Size Default Description Visible Mutable Nullable
State ENUM RUNNING Value set: RUNNING, COMPLETED yes no no
PrimaryTeamContactPerson VIRTUAL not set yes no yes
SecondaryTeamContactPerson VIRTUAL not set yes no yes
TertiaryTeamContactPerson VIRTUAL not set yes no yes
Title VARCHAR 128 not set yes no no
Subtitle VARCHAR 128 not set yes no yes
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
DateStart DATE not set yes no yes
DateEnd DATE not set yes no yes

Interfaces

Found 2 interfaces in class Awo\ContentVendor\Extension\Project\Controller\Api\V1\ProjectController

Resource: Project, Method: pdfDocument

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

Endpoint
GET /project-extension/api/v1/project/{uuid}/pdfDocument/{which}/
Request header
Bearer Token named Authorization

Resource: Project, Method: load

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

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

HTTP/1.1 200 Ok
Date: Fri, 06 Mar 2020 11:31:02 +0000
Content-Length: 3232
Content-Type: application/json
{
    "AwoProjectModel": {
        "State": "RUNNING",
        "PrimaryTeamContactPerson": {
            "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"
        },
        "SecondaryTeamContactPerson": {
            "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"
        },
        "TertiaryTeamContactPerson": {
            "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",
        "Subtitle": "Some descriptive subtitle",
        "PrimaryPdfDocumentTitle": "EU Richtlinien",
        "SecondaryPdfDocumentTitle": "EU Richtlinien",
        "TertiaryPdfDocumentTitle": "EU Richtlinien",
        "PrimaryPdfDocumentUrl": "\/project-extension\/api\/v1\/project\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/primary",
        "SecondaryPdfDocumentUrl": "\/project-extension\/api\/v1\/project\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/secondary",
        "TertiaryPdfDocumentUrl": "\/project-extension\/api\/v1\/project\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/tertiary",
        "DateStart": "2013-11-12",
        "DateEnd": "2013-11-12"
    },
    "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 /project-extension/api/v1/project/{uuid}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Fri, 06 Mar 2020 11:31:02 +0000                      

                      Content-Length: 3232                      

                      Content-Type: application/json
                                              

                        {
    "AwoProjectModel": {
        "State": "RUNNING",
        "PrimaryTeamContactPerson": {
            "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"
        },
        "SecondaryTeamContactPerson": {
            "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"
        },
        "TertiaryTeamContactPerson": {
            "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",
        "Subtitle": "Some descriptive subtitle",
        "PrimaryPdfDocumentTitle": "EU Richtlinien",
        "SecondaryPdfDocumentTitle": "EU Richtlinien",
        "TertiaryPdfDocumentTitle": "EU Richtlinien",
        "PrimaryPdfDocumentUrl": "\/project-extension\/api\/v1\/project\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/primary",
        "SecondaryPdfDocumentUrl": "\/project-extension\/api\/v1\/project\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/secondary",
        "TertiaryPdfDocumentUrl": "\/project-extension\/api\/v1\/project\/a76a8fa7-5220-4b6f-bfae-f383b0aff76b\/pdf-document\/tertiary",
        "DateStart": "2013-11-12",
        "DateEnd": "2013-11-12"
    },
    "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
FilteredProjectControllerModel named AwoProjectModel