/ByPromotionalEligible

Get User by Promotion Eligibility

Returns user data based on their promotion eligibility.

Request

• URL

  /api/v1/roster/users/bypromotionaleligible

• Method

  GET

• Query Parameters

  • eligible: The promotion eligibility status 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 an eligibility."
    }

  OR

  • Code: 404 Not Found

  • Content:

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

• Sample Call

  GET https://api.arma.origin-development.net/api/v1/roster/users/bypromotionaleligible?eligible=true

Notes

• This endpoint retrieves user data based on their promotion eligibility status.

• The eligibility status is required as a query parameter (true or false).

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