API introspection – List packages, resources and their interfaces

Found 8 resources

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

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

Controller providing business division contact person related collection actions.

Name Type Size Default Description Visible Mutable Nullable
BusinessDivisionUuid VIRTUAL not set yes no yes
DefaultContactPerson BOOLEAN yes no no
Firstname VARCHAR 128 not set yes no no
Lastname VARCHAR 128 not set yes no no
PositionClass ENUM CONTACT_PERSON Value set: PRESIDENT, VICE_PRESIDENT, ASSISTANT_TO_THE_PRESIDENT, DIVISION_LEAD, VICE_DIVISION_LEAD, ASSISTANT_TO_THE_DIVISION_LEAD, FACILITY_LEAD, VICE_FACILITY_LEAD, ASSISTANT_TO_THE_FACILITY_LEAD, CONTACT_PERSON yes no no
Position VARCHAR 128 not set yes no yes
PhoneNumber VARCHAR 128 not set yes no yes
MobilePhoneNumber VARCHAR 128 not set yes no yes
MailAddress VARCHAR 128 not set yes no yes
Languages VARCHAR 256 not set yes no yes
OfficeHours LONGVARCHAR not set yes no yes
CreatedAt TIMESTAMP not set yes no yes
UpdatedAt TIMESTAMP not set yes no yes
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 2 interfaces in class Awo\ContentVendor\Extension\BusinessDivision\Controller\Api\V1\BusinessDivisionContactPersonsController

Resource: BusinessDivisionContactPersons, Method: find

Loads a model collection or throws an exception

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

HTTP/1.1 200 Ok
Date: Tue, 11 Feb 2020 11:45:52 +0000
Content-Length: 1934
Content-Type: application/json
{
    "BusinessDivisionContactPersonModelCollection": [
        {
            "BusinessDivisionUuid": null,
            "DefaultContactPerson": true,
            "Firstname": "John",
            "Lastname": "Doe",
            "PositionClass": "PRESIDENT",
            "Position": "Chief of some of the things",
            "PhoneNumber": "0431 2400668",
            "MobilePhoneNumber": "0151 23456789",
            "MailAddress": "mb@markenwerk.net",
            "Languages": "deutsch, englisch, russisch",
            "OfficeHours": "",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "BusinessDivisionContactPersonModelCollection",
        "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 /extension/api/v1/business-division-contact-persons
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Tue, 11 Feb 2020 11:45:52 +0000                      

                      Content-Length: 1934                      

                      Content-Type: application/json
                                              

                        {
    "BusinessDivisionContactPersonModelCollection": [
        {
            "BusinessDivisionUuid": null,
            "DefaultContactPerson": true,
            "Firstname": "John",
            "Lastname": "Doe",
            "PositionClass": "PRESIDENT",
            "Position": "Chief of some of the things",
            "PhoneNumber": "0431 2400668",
            "MobilePhoneNumber": "0151 23456789",
            "MailAddress": "mb@markenwerk.net",
            "Languages": "deutsch, englisch, russisch",
            "OfficeHours": "",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "BusinessDivisionContactPersonModelCollection",
        "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
        }
    ]
}
Response data
FilteredBusinessDivisionContactPersonsControllerModel[] named BusinessDivisionContactPersonModelCollection

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

HTTP/1.1 200 Ok
Date: Tue, 11 Feb 2020 11:45:52 +0000
Content-Length: 1934
Content-Type: application/json
{
    "BusinessDivisionContactPersonModelCollection": [
        {
            "BusinessDivisionUuid": null,
            "DefaultContactPerson": true,
            "Firstname": "John",
            "Lastname": "Doe",
            "PositionClass": "PRESIDENT",
            "Position": "Chief of some of the things",
            "PhoneNumber": "0431 2400668",
            "MobilePhoneNumber": "0151 23456789",
            "MailAddress": "mb@markenwerk.net",
            "Languages": "deutsch, englisch, russisch",
            "OfficeHours": "",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "BusinessDivisionContactPersonModelCollection",
        "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 /extension/api/v1/business-division-contact-persons/page/{?page}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Tue, 11 Feb 2020 11:45:52 +0000                      

                      Content-Length: 1934                      

                      Content-Type: application/json
                                              

                        {
    "BusinessDivisionContactPersonModelCollection": [
        {
            "BusinessDivisionUuid": null,
            "DefaultContactPerson": true,
            "Firstname": "John",
            "Lastname": "Doe",
            "PositionClass": "PRESIDENT",
            "Position": "Chief of some of the things",
            "PhoneNumber": "0431 2400668",
            "MobilePhoneNumber": "0151 23456789",
            "MailAddress": "mb@markenwerk.net",
            "Languages": "deutsch, englisch, russisch",
            "OfficeHours": "",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "BusinessDivisionContactPersonModelCollection",
        "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
        }
    ]
}
Response data
FilteredBusinessDivisionContactPersonsControllerModel[] named BusinessDivisionContactPersonModelCollection