Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 1.44 KB

staff.md

File metadata and controls

49 lines (39 loc) · 1.44 KB

staff Endpoint

The staff endpoint requests all staff members of the room you are currently in.

You can view information on staff roles, here.

Endpoint

staff

Method

GET

Possible error messages

Insufficient permissions (not being logged in)

{
    "data": [
        "You are not authorized to access this resource."
    ],
    "status": "notAuthorized",
}

Data returned

{
    'data': [{              // Contains the requested data
        'avatarID': 'xxx',  // AvatarID (e.g.: 'base01')
        'badge': 'xxx',     // Badge of the DJ (e.g.: '80sb01')
        'gRole': 0,         // Global role of the user (0 = None; 3 = Brand Ambassador (BA); 5 = Admin)
        'guest': false,     // Is the DJ a guest? (this is not possible as of now)
        'id': -1,           // ID of the DJ
        'joined': 'xxx',    // String representation of the time the DJ joined plug (e.g.: '2014-07-23 22:47:00.573000')
        'language': 'xx',   // ISO 639-1 representation of the language used by the DJ
        'level': 1,         // Level of the DJ,
        'role': 1,          // Role of the user in this room
        'slug': 'xxx',      // URL conform representation of the DJ's name (also used for the profile page)
        'sub': 0,           // Is the DJ a subscriber? (0 = false; 1 = true)
        'username': 'xxx'   // Name of the DJ
    }],
    'meta': {},
    'status': 'ok',
    'time': 'xx.xxxxxxxxxxx'
}