/ByRole

Get Users by Role

Returns a list of users based on their role.

Request

• URL

  /api/v1/roster/users/byrole

• Method

  GET

• Query Parameters

  • role: The role for which users are to be fetched.

Response

• Success Response

  • Code: 200 OK

  • Content: An array containing a single user object.

    [
        {
            "user_info": {
                "discord_id": "123456789012345678",
                "discord_user": "username#1234"
            },
            "arma_data": {
                "ingame_name": "IngameName",
                "rank_name": "RankName",
                "team_name": "TeamName",
                "default_role": "DefaultRole",
                "abv": "ABV",
                "time_in_grade": "TimeInGrade",
                "ao_points": "AOPoints",
                "promotion_eligible": "PromotionEligible",
                "hire_date": "HireDate",
                "promotion_date": "PromotionDate"
            }
        }
    ]

• Error Response

  • Code: 400 Bad Request

  • Content:

    {
        "error": "Please provide a role."
    }

  OR

  • Code: 404 Not Found

  • Content:

    {
        "error": "No users are correlated with that role."
    }

• Sample Call

  GET https://api.arma.origin-development.net/api/v1/roster/users/byrole?role=someRole

Notes

• This endpoint retrieves users based on their role.

• The role name is required as a query parameter.

• If no role name is provided or no users match the role, appropriate error messages are returned.