Reference

Guide

/api/roles/:id

Retrieve a role

GET: /api/roles/:id

Query parameters

Parameter Example Description
pretty ?pretty=true Pretty prints the result. Only useful for debugging.
select ?select=name,locale Defines the fields that will be returned for the language.

Role fields

The following fields are available in the role model and can be fetched with the select parameter:

  • description
  • name
  • permissions
  • title

Example response

GET: /api/languages/de
{
    "code": 200,
    "data": {
        "code": "de",
        "default": false,
        "direction": "ltr",
        "locale": "de_DE",
        "name": "Deutsch",
        "url": "http://kir.by/de"
    },
    "status": "ok",
    "type": "model"
}