API introspection – List packages, resources and their interfaces

Found 6 resources

Resource class Smartarchivo\Controller\Core\Api\V1\MembershipController of type EntityController
No access control

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

Name Type Size Default Description Visible Mutable Nullable
Actor VIRTUAL not set yes no yes
Roles VIRTUAL not set yes no yes
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 5 interfaces in class Smartarchivo\Controller\Core\Api\V1\MembershipController

Resource: Membership, Method: load

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

Endpoint
GET /core/api/v1/{clientUuid}/{facilityUuid}/membership/{uuid}/
Example request 
GET /core/api/v1/{clientUuid}/{facilityUuid}/membership/{uuid}
Host: /
Accept: application/json
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1210
Content-Type: application/json
{
    "MembershipModel": {
        "Actor": {
            "Type": "OWNER",
            "State": "INACTIVE",
            "MailAddress": "john.doe@mail.com",
            "Username": "john.doe",
            "Realname": "John Doe",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "Roles": [
            {
                "Name": "Siteadmin",
                "Description": "Provides permissions for actors",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "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
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredMembershipControllerModel named MembershipModel

Resource: Membership, Method: loadDefault

Loads an item holding the default attributes

Endpoint
GET /core/api/v1/{clientUuid}/{facilityUuid}/membership/
Example request 
GET /core/api/v1/{clientUuid}/{facilityUuid}/membership
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1210
Content-Type: application/json
{
    "MembershipModel": {
        "Actor": {
            "Type": "OWNER",
            "State": "INACTIVE",
            "MailAddress": "john.doe@mail.com",
            "Username": "john.doe",
            "Realname": "John Doe",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "Roles": [
            {
                "Name": "Siteadmin",
                "Description": "Provides permissions for actors",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "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
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredMembershipControllerModel named MembershipModel

Resource: Membership, Method: create

Creates a new membership for an actor that is not already a member of the current facility. If the actor is already existing
(identified by the mail address or username) it is used for the membership. After creating a new membership the actor is informed by
mail.

Endpoint
POST /core/api/v1/{clientUuid}/{facilityUuid}/membership/
Example request 
POST /core/api/v1/{clientUuid}/{facilityUuid}/membership
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 448
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Model": {
        "Actor": {
            "MailAddress": "john.doe@mail.com",
            "Username": "john.doe",
            "Realname": "John Doe",
            "Password": "my super secret password"
        },
        "Roles": [
            {
                "Name": "Siteadmin",
                "Description": "Provides permissions for actors",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ]
    }
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1210
Content-Type: application/json
{
    "MembershipModel": {
        "Actor": {
            "Type": "OWNER",
            "State": "INACTIVE",
            "MailAddress": "john.doe@mail.com",
            "Username": "john.doe",
            "Realname": "John Doe",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "Roles": [
            {
                "Name": "Siteadmin",
                "Description": "Provides permissions for actors",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "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
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Request data
FilteredMembershipControllerModel
Response data
FilteredMembershipControllerModel named MembershipModel

Resource: Membership, Method: update

Updates model with properties given by request

Endpoint
PUT /core/api/v1/{clientUuid}/{facilityUuid}/membership/{Uuid}/
Example request 
PUT /core/api/v1/{clientUuid}/{facilityUuid}/membership/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 247
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Model": {
        "Roles": [
            {
                "Name": "Siteadmin",
                "Description": "Provides permissions for actors",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ]
    }
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1210
Content-Type: application/json
{
    "MembershipModel": {
        "Actor": {
            "Type": "OWNER",
            "State": "INACTIVE",
            "MailAddress": "john.doe@mail.com",
            "Username": "john.doe",
            "Realname": "John Doe",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "Roles": [
            {
                "Name": "Siteadmin",
                "Description": "Provides permissions for actors",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "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
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Request data
FilteredMembershipControllerModel
Response data
FilteredMembershipControllerModel named MembershipModel

Resource: Membership, Method: delete

Deletes the loaded model

Endpoint
DELETE /core/api/v1/{clientUuid}/{facilityUuid}/membership/{Uuid}/
Example request 
DELETE /core/api/v1/{clientUuid}/{facilityUuid}/membership/{Uuid}
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1210
Content-Type: application/json
{
    "MembershipModel": {
        "Actor": {
            "Type": "OWNER",
            "State": "INACTIVE",
            "MailAddress": "john.doe@mail.com",
            "Username": "john.doe",
            "Realname": "John Doe",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        },
        "Roles": [
            {
                "Name": "Siteadmin",
                "Description": "Provides permissions for actors",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "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
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredMembershipControllerModel named MembershipModel