API introspection – List packages, resources and their interfaces

Found 2 resources

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

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

Controller providing contact person related collection 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\ContactPersonsController

Resource: ContactPersons, Method: find

Loads a model collection or throws an exception

Endpoint
GET /team-extension/api/v1/contact-persons/
Example request 
GET /team-extension/api/v1/contact-persons
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Fri, 06 Mar 2020 14:25:26 +0000
Content-Length: 1874
Content-Type: application/json
{
    "AwoTeamContactPersonModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoTeamContactPersonModelCollection",
        "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 /team-extension/api/v1/contact-persons
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

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

                      Content-Length: 1874                      

                      Content-Type: application/json
                                              

                        {
    "AwoTeamContactPersonModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoTeamContactPersonModelCollection",
        "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
FilteredContactPersonsControllerModel[] named AwoTeamContactPersonModelCollection

Resource: ContactPersons, 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 /team-extension/api/v1/contact-persons/page/{?page}/
Example request 
GET /team-extension/api/v1/contact-persons/page/{?page}
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Fri, 06 Mar 2020 14:25:26 +0000
Content-Length: 1874
Content-Type: application/json
{
    "AwoTeamContactPersonModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoTeamContactPersonModelCollection",
        "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 /team-extension/api/v1/contact-persons/page/{?page}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

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

                      Content-Length: 1874                      

                      Content-Type: application/json
                                              

                        {
    "AwoTeamContactPersonModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "AwoTeamContactPersonModelCollection",
        "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
FilteredContactPersonsControllerModel[] named AwoTeamContactPersonModelCollection