API introspection – List packages, resources and their interfaces

Found 8 resources

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

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

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

Name Type Size Default Description Visible Mutable Nullable
Name VARCHAR 128 not set yes no no
Identifier VARCHAR 128 not set yes no no
Color VARCHAR 8 e2001a yes no no
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 1 interfaces in class Awo\ContentVendor\Extension\BusinessDivision\Controller\Api\V1\BusinessDivisionController

Resource: BusinessDivision, Method: load

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

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

HTTP/1.1 200 Ok
Date: Tue, 11 Feb 2020 11:45:51 +0000
Content-Length: 862
Content-Type: application/json
{
    "BusinessDivisionModel": {
        "Name": "Landesverband",
        "Identifier": "LANDESVERBAND",
        "Color": "ff00ffff",
        "BusinessDivisionContactPersons": null,
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "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 /extension/api/v1/business-division/{uuid}
                      

                      Host: /                      

                      Accept: application/json
                                            
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

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

                      Content-Length: 862                      

                      Content-Type: application/json
                                              

                        {
    "BusinessDivisionModel": {
        "Name": "Landesverband",
        "Identifier": "LANDESVERBAND",
        "Color": "ff00ffff",
        "BusinessDivisionContactPersons": null,
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "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
        }
    ]
}
Response data
FilteredBusinessDivisionControllerModel named BusinessDivisionModel