API introspection – List packages, resources and their interfaces

Found 2 resources

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

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

Controller providing contact person related entity actions.

Name Type Size Default Description Visible Mutable Nullable
Department ENUM ADMINISTRATION Value set: ADMINISTRATION, CONSULTING yes no no
Fullname VARCHAR 128 not set yes no no
Position VARCHAR 128 not set yes no yes
PortraitUrl VIRTUAL not set yes no yes
PhoneNumber VARCHAR 32 not set yes no yes
MailAddress VARCHAR 64 not set yes no yes
AddressStreet VARCHAR 128 not set yes no yes
AddressZip VARCHAR 5 not set yes no yes
AddressCity VARCHAR 64 not set yes no yes
Description LONGVARCHAR not set yes no yes
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 2 interfaces in class Awo\ContentVendor\Extension\Team\Controller\Api\V1\ContactPersonController

Resource: ContactPerson, Method: portrait

Provides the portrait file as cropped, scaled and optimized image binary if available or creates a not found response

Endpoint
GET /team-extension/api/v1/contact-person/{uuid}/portrait/{?width}/{?height}/
Request header
Bearer Token named Authorization

Resource: ContactPerson, Method: load

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

Endpoint
GET /team-extension/api/v1/contact-person/{uuid}/
Example request 
GET /team-extension/api/v1/contact-person/{uuid}
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Fri, 06 Mar 2020 14:25:26 +0000
Content-Length: 1116
Content-Type: application/json
{
    "AwoTeamContactPersonModel": {
        "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"
    },
    "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 /team-extension/api/v1/contact-person/{uuid}
                      

                      Host: /                      

                      Accept: application/json
                                                                                              

                          Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=                                              
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Fri, 06 Mar 2020 14:25:26 +0000                      

                      Content-Length: 1116                      

                      Content-Type: application/json
                                              

                        {
    "AwoTeamContactPersonModel": {
        "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"
    },
    "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
FilteredContactPersonControllerModel named AwoTeamContactPersonModel