REST API Extension Kit

Add-ons REST API Extension Kit 1.2

Register & Get access to index
Overview History Discussion
Compatible XF Versions
2.3
Visible Branding
No
A small collection of REST API enhancements.

New Scopes:
  1. apikit_user_group:read - Makes the new user-groups endpoint accessible
  2. apikit_thread_prefix:read - Makes the new thread-prefixes endpoint accessible
New Endpoints:
  1. user-groups - List of XF Usergroups:
PHP: 
Array(
    [0] => stdClass Object
        (
            [banner_css_class] => userBanner userBanner--accent
            [display_style_priority] => 0
            [title] => Unregistered / Unconfirmed
            [user_group_id] => 1
            [username_css] => color: red; font-weight: bold;
        )
    ...
)
thread-prefixes - List of Thread Prefixes:
PHP: 
Array(
    [0] => stdClass Object
        (
            [color_label] => lightGreen
            [css_class] => label label--lightGreen
            [description] => Prefix description here.
            [display_order] => 1
            [is_usable] => 1
            [materialized_order] => 1
            [prefix_group_id] => 0
            [prefix_id] => 1
            [title] => Prefix Name
            [usage_help] =>
        )
    ...
)

New Parameters:
  1. /threads/

    (bool) most_replies - List threads (sitewide) that have been replied to within the last 30 days, sorted by reply count.

    (bool) most_viewed - List most viewed threads (sitewide).

    Return: List of Thread[] Object(s).

  2. /users/ - Can now return list of users by usergroup and/or secondary usergroup(s).

    (int) user_group_id - Enter ID of usergroup to search users by.

    (array) secondary_group_ids - Enter ID(s) of secondary usergroup(s) to search by.

    Return: List of User[] Objects.
Author
XenForo
Views
First release
Last update
Rating
0.00 star(s) 0 ratings
Join the discussion More information

More resources from XenForo

Share this resource

Back
Top Bottom