Table of Contents
Routes
- badge-categories
- badge-tiers
- badges
- user-badges
Routes
badge-categories
GET badge-categories/
Gets the API list of badge categories.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| OzzModz_Badges_BadgeCategory[] | mixed | |
DELETE badge-categories/{id}/
Deletes the specified badge category.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| success | true | |
badge-tiers
GET badge-tiers/
Gets the API list of badge tiers.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| OzzModz_Badges_BadgeTier[] | mixed | |
DELETE badge-tiers/{id}/
Deletes the specified badge tier.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| success | true | |
badges
GET badges/
Gets the API list of badges.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| OzzModz_Badges_Badge[] | mixed | |
DELETE badges/{id}/
Deletes the specified badge.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| success | true | |
POST badges/{id}/award
Awards user with badge.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| UserBadge[] | mixed | |
user-badges
GET user-badges/
Gets the API list of user badges.
| Inputs | Type | Description |
|---|
| page | integer | |
| user_id | integer | Only gets specified user badges |
| badge_id | integer | Only gets specified badge id |
| badge_category_id | integer | Only gets badges from category if specified |
| badge_tier_id | integer | Only gets badges with tier if specified |
| Outputs | Type | Description |
|---|
| userBadges | OzzModz_Badges_UserBadge[] | |
| pagination | pagination | |
POST user-badges/
Awards user with badge.
| Inputs | Type | Description |
|---|
| badge_id | integer | [req] |
| user_id | integer | [req] |
| Outputs | Type | Description |
|---|
| UserBadge[] | mixed | |
DELETE user-badges/{id}/
Deletes the specified user badge.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| success | true | |
POST user-badges/{id}/edit
Edits reason for user badge
| Inputs | Type | Description |
|---|
| reason | string | [req] |
| Outputs | Type | Description |
|---|
| OzzModz_Badges_UserBadge[] | mixed | |
POST user-badges/{id}/feature
Toggles featured state the specified user badge.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| OzzModz_Badges_UserBadge[] | mixed | |
Types
OzzModz_Badges_Badge
| Structure | Type | Description |
|---|
| title | string | |
| description | string | |
| badge_id | integer | |
| badge_category_id | integer | |
| badge_tier_id | integer | |
| user_criteria | array | |
| icon_type | string | |
| fa_icon | string | |
| mdi_icon | string | |
| image_url | string | |
| image_url_2x | string | |
| image_url_3x | string | |
| image_url_4x | string | |
| class | string | |
| awarded_number | integer | |
| is_repetitive | bool | |
| repeat_delay | integer | |
| is_revoked | bool | |
| is_manually_awarded | bool | |
| stacking_badge_id | integer | |
| display_order | integer | |
| active | bool | |
OzzModz_Badges_BadgeCategory
| Structure | Type | Description |
|---|
| title | string | |
| badge_category_id | integer | |
| icon_type | string | |
| fa_icon | string | |
| mdi_icon | string | |
| image_url | string | |
| image_url_2x | string | |
| image_url_3x | string | |
| image_url_4x | string | |
| class | string | |
| display_order | integer | |
OzzModz_Badges_BadgeTier
| Structure | Type | Description |
|---|
| title | string | |
| badge_tier_id | integer | |
| color | string | |
| css | string | |
| display_order | integer | |
OzzModz_Badges_UserBadge
| Structure | Type | Description |
|---|
| badge_title | string | |
| user_badge_id | integer | |
| user_id | integer | |
| awarding_user_id | integer | |
| is_manually_awarded | bool | |
| badge_id | integer | |
| award_date | integer | |
| reason | string | |
| featured | bool | |