API introspection – List packages, resources and their interfaces

Found 8 resources

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

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

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

Name Type Size Default Description Visible Mutable Nullable
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
OfficeHours LONGVARCHAR not set yes no yes
BusinessDivisionContactPersons VIRTUAL not set yes no yes

Interfaces

Found 1 interfaces in class Awo\ContentVendor\Extension\BusinessDivision\Controller\Api\V1\BusinessDivisionFacilityController

Resource: BusinessDivisionFacility, Method: load

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

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

HTTP/1.1 200 Ok
Date: Tue, 11 Feb 2020 11:45:52 +0000
Content-Length: 1103
Content-Type: application/json
{
    "BusinessDivisionFacilityModel": {
        "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": "",
        "OfficeHours": "",
        "BusinessDivisionContactPersons": null
    },
    "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-facility/{uuid}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

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

                      Content-Length: 1103                      

                      Content-Type: application/json
                                              

                        {
    "BusinessDivisionFacilityModel": {
        "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": "",
        "OfficeHours": "",
        "BusinessDivisionContactPersons": null
    },
    "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
FilteredBusinessDivisionFacilityControllerModel named BusinessDivisionFacilityModel