API introspection – List packages, resources and their interfaces

Found 8 resources

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

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

Controller providing business division facility related collection actions like listing, filtering and searching.

Name Type Size Default Description Visible Mutable Nullable
BusinessDivisionUuid VIRTUAL not set yes no yes
Name VARCHAR 128 not set yes no no
ShowOnMap BOOLEAN 1 yes no no
AddressStreet VARCHAR 128 not set yes no yes
AddressHouse VARCHAR 8 not set yes no yes
AddressAddition VARCHAR 128 not set yes no yes
AddressZip VARCHAR 8 not set yes no no
AddressCity VARCHAR 128 not set yes no no
GeoCoordinatesLongitude FLOAT not set yes no no
GeoCoordinatesLatitude FLOAT not set yes no no
PhoneNumber VARCHAR 128 not set yes no yes
MailAddress VARCHAR 128 not set yes no yes
InformationArticleUuid VARCHAR 36 not set yes no yes
InformationArticleUrl VIRTUAL not set yes no yes
OfficeHours LONGVARCHAR not set yes no yes
BusinessDivisionContactPersons VIRTUAL 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\BusinessDivisionFacilitiesController

Resource: BusinessDivisionFacilities, Method: find

Loads a model collection or throws an exception

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

HTTP/1.1 200 Ok
Date: Tue, 11 Feb 2020 11:45:52 +0000
Content-Length: 2118
Content-Type: application/json
{
    "BusinessDivisionFacilityModelCollection": [
        {
            "BusinessDivisionUuid": null,
            "Name": "Zentrale",
            "ShowOnMap": true,
            "AddressStreet": "Lornsenstraße",
            "AddressHouse": "43a",
            "AddressAddition": "Hinterhaus",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "GeoCoordinatesLongitude": 54.334017,
            "GeoCoordinatesLatitude": 10.136461,
            "PhoneNumber": "+49 0431 240066-6",
            "MailAddress": "post@markenwerk.net",
            "InformationArticleUuid": "",
            "InformationArticleUrl": null,
            "OfficeHours": "",
            "BusinessDivisionContactPersons": null,
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "BusinessDivisionFacilityModelCollection",
        "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-facilities
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

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

                      Content-Length: 2118                      

                      Content-Type: application/json
                                              

                        {
    "BusinessDivisionFacilityModelCollection": [
        {
            "BusinessDivisionUuid": null,
            "Name": "Zentrale",
            "ShowOnMap": true,
            "AddressStreet": "Lornsenstraße",
            "AddressHouse": "43a",
            "AddressAddition": "Hinterhaus",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "GeoCoordinatesLongitude": 54.334017,
            "GeoCoordinatesLatitude": 10.136461,
            "PhoneNumber": "+49 0431 240066-6",
            "MailAddress": "post@markenwerk.net",
            "InformationArticleUuid": "",
            "InformationArticleUrl": null,
            "OfficeHours": "",
            "BusinessDivisionContactPersons": null,
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "BusinessDivisionFacilityModelCollection",
        "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
FilteredBusinessDivisionFacilitiesControllerModel[] named BusinessDivisionFacilityModelCollection

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

HTTP/1.1 200 Ok
Date: Tue, 11 Feb 2020 11:45:52 +0000
Content-Length: 2118
Content-Type: application/json
{
    "BusinessDivisionFacilityModelCollection": [
        {
            "BusinessDivisionUuid": null,
            "Name": "Zentrale",
            "ShowOnMap": true,
            "AddressStreet": "Lornsenstraße",
            "AddressHouse": "43a",
            "AddressAddition": "Hinterhaus",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "GeoCoordinatesLongitude": 54.334017,
            "GeoCoordinatesLatitude": 10.136461,
            "PhoneNumber": "+49 0431 240066-6",
            "MailAddress": "post@markenwerk.net",
            "InformationArticleUuid": "",
            "InformationArticleUrl": null,
            "OfficeHours": "",
            "BusinessDivisionContactPersons": null,
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "BusinessDivisionFacilityModelCollection",
        "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-facilities/page/{?page}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

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

                      Content-Length: 2118                      

                      Content-Type: application/json
                                              

                        {
    "BusinessDivisionFacilityModelCollection": [
        {
            "BusinessDivisionUuid": null,
            "Name": "Zentrale",
            "ShowOnMap": true,
            "AddressStreet": "Lornsenstraße",
            "AddressHouse": "43a",
            "AddressAddition": "Hinterhaus",
            "AddressZip": "24105",
            "AddressCity": "Kiel",
            "GeoCoordinatesLongitude": 54.334017,
            "GeoCoordinatesLatitude": 10.136461,
            "PhoneNumber": "+49 0431 240066-6",
            "MailAddress": "post@markenwerk.net",
            "InformationArticleUuid": "",
            "InformationArticleUrl": null,
            "OfficeHours": "",
            "BusinessDivisionContactPersons": null,
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "BusinessDivisionFacilityModelCollection",
        "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
FilteredBusinessDivisionFacilitiesControllerModel[] named BusinessDivisionFacilityModelCollection