/ByTimeInGrade

Get Users by Time in Grade

Returns a list of users based on their time in grade.

Request

• URL

  /api/v1/roster/users/bytimeingrade

• Method

  GET

• Query Parameters

  • time: The time in grade for which users are to be fetched.

Response

• Success Response

  • Code: 200 OK

  • Content: An array of user objects, each containing user information.

    [
        {
            "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"
            }
        },
        {
            "user_info": {
                "discord_id": "987654321098765432",
                "discord_user": "anotherusername#5678"
            },
            "arma_data": {
                "ingame_name": "AnotherIngameName",
                "rank_name": "AnotherRankName",
                "team_name": "AnotherTeamName",
                "default_role": "AnotherDefaultRole",
                "abv": "AnotherABV",
                "time_in_grade": "AnotherTimeInGrade",
                "ao_points": "AnotherAOPoints",
                "promotion_eligible": "AnotherPromotionEligible",
                "hire_date": "AnotherHireDate",
                "promotion_date": "AnotherPromotionDate"
            }
        },
        ...
    ]

• Error Response

  • Code: 400 Bad Request

  • Content:

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

  OR

  • Code: 404 Not Found

  • Content:

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

• Sample Call

  GET https://api.arma.origin-development.net/api/v1/roster/users/bytimeingrade?time=someTime

Notes

• This endpoint retrieves users based on their time in grade.

• The time in grade is required as a query parameter.

• If no time in grade is provided or no users match the specified time, appropriate error messages are returned.