Modules API

Shop is divided into sections so-called modules. Each role can obtain certain permissions for active modules to manage system access.

Content

Modules collection:

• [GET] index, searching and filtering modules

Single module:

• [GET] module detail

Modules collection

Modules index

Request

Index behaviour	Definition
Paginated by default	No
Sorting	-
Filters	-
Embedded	-

GET /api/modules HTTP/1.1
Content-Type: application/json

Response

200 OK

GET /api/modules HTTP/1.1
Content-Type: application/json

{
    "items": [
        {
            "id": "articles",
            "name": "Articles",
            "is_active": true,
            "_links": [
                {
                    "href": "/api/modules/articles",
                    "rel": "self",
                    "type": "GET"
                }
            ]
        },
        {
            "id": "banners",
            "name": "Banners",
            "is_active": true,
            "_links": [
                {
                    "href": "/api/modules/banners",
                    "rel": "self",
                    "type": "GET"
                }
            ]
        }
    ]
}

---

---

Single module

Module detail

GET /api/modules/{module_id}

Get Module detail.

Request

Index behaviour	Definition
Embedded	-

Request

GET /api/modules/articles HTTP/1.1
Content-Type: application/json

Response

200 OK

GET /api/modules/articles HTTP/1.1
Content-Type: application/json

{
    "id": "articles",
    "name": "Articles",
    "is_active": true,
    "_links": [
        {
            "href": "/api/modules/articles",
            "rel": "self",
            "type": "GET"
        }
    ]
}

404 NOT FOUND

Module was not found.

GET /api/modules/idkman HTTP/1.1
Content-Type: application/json
Status-Code: 404

{
    "type": "NotFound",
    "message": "Required model was not found.",
    "id": "0cd85449-05fe-4866-9802-8192e6785fc7"
}