API introspection – List packages, resources and their interfaces

Found 9 resources

Resource class ContentVendor\Controller\Api\V1\AuthorController of type EntityController
Access controlled by ContentVendor\Core\Api\AccessRule\ApiAccessRule

Endpoint to recieve an author model by its UUID

Name Type Size Default Description Visible Mutable Nullable
Type ENUM USER Value set: SYSADMIN, ADMIN, USER yes no no
MailAddress VARCHAR 128 not set yes no no
Username VARCHAR 128 not set yes no no
Realname VARCHAR 128 not set yes no no
AvatarUrl VIRTUAL not set yes no yes
CustomAttributes VIRTUAL not set yes no yes
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 2 interfaces in class ContentVendor\Controller\Api\V1\AuthorController

Resource: Author, Method: load

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

Endpoint
GET /api/v1/author/{uuid}/
Example request 
GET /api/v1/author/{uuid}
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
Accept-Language: de-DE,de;q=0.8,en-US;q=0.5,en;q=0.3

HTTP/1.1 200 Ok
Date: Sat, 15 Feb 2020 13:52:06 +0000
Content-Length: 1363
Content-Type: application/json
Cache-Control: public, max-age=86400
Expires: Sun, 16 Feb 2020 13:52:06 GMT
Last-Modified: Sat, 15 Feb 2020 13:52:06 GMT
{
    "ActorModel": {
        "Type": "SYSADMIN",
        "MailAddress": "john.doe@mail.com",
        "Username": "jdoe",
        "Realname": "John Doe",
        "AvatarUrl": "\/api\/v1\/author\/123e4567-e89b-12d3-a456-426655440000\/avatar\/512\/",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000",
        "CustomAttributes": {
            "CUSTOM_ATTRIBUTE_IDENTIFIER_1": "Custom attribute string value",
            "CUSTOM_ATTRIBUTE_IDENTIFIER_2": true,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_3": 1279,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_4": 23.194687,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_5": [
                "Custom",
                "attribute list",
                "value"
            ],
            "CUSTOM_ATTRIBUTE_IDENTIFIER_6": "Custom attribute selected value from enum value set"
        }
    },
    "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 /api/v1/author/{uuid}
                      

                      Host: /                      

                      Accept: application/json
                                                                                              

                          Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=                                                  

                          Accept-Language: de-DE,de;q=0.8,en-US;q=0.5,en;q=0.3                                              
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Sat, 15 Feb 2020 13:52:06 +0000                      

                      Content-Length: 1363                      

                      Content-Type: application/json
                                              

                        {
    "ActorModel": {
        "Type": "SYSADMIN",
        "MailAddress": "john.doe@mail.com",
        "Username": "jdoe",
        "Realname": "John Doe",
        "AvatarUrl": "\/api\/v1\/author\/123e4567-e89b-12d3-a456-426655440000\/avatar\/512\/",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000",
        "CustomAttributes": {
            "CUSTOM_ATTRIBUTE_IDENTIFIER_1": "Custom attribute string value",
            "CUSTOM_ATTRIBUTE_IDENTIFIER_2": true,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_3": 1279,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_4": 23.194687,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_5": [
                "Custom",
                "attribute list",
                "value"
            ],
            "CUSTOM_ATTRIBUTE_IDENTIFIER_6": "Custom attribute selected value from enum value set"
        }
    },
    "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
The Clients Last Modified Date Time As HTTP Date (RFC 2616) named If-Modified-Since
Bearer Token named Authorization
Response header
The Servers Cache Control Instruction named Cache-Control
The Servers Cache Expiration Instruction As HTTP Date (RFC 2616) named Expires
The Servers Last Modified Date Time As HTTP Date (RFC 2616) named Last-Modified
Response data
FilteredAuthorControllerModel named ActorModel

Resource: Author, Method: avatar

Provides the author avatar file as optimized image. If the size parameter is passed the image will be cropped and scaled to a square
of the given width and height.

Endpoint
GET /api/v1/author/{uuid}/avatar/{?size}/
Request header
The Clients Last Modified Date Time As HTTP Date (RFC 2616) named If-Modified-Since
Response header
The Servers Cache Control Instruction named Cache-Control
The Servers Cache Expiration Instruction As HTTP Date (RFC 2616) named Expires
The Servers Last Modified Date Time As HTTP Date (RFC 2616) named Last-Modified