/ByIngameName

Get User by Ingame Name

Returns user data based on their in-game name.

Request

• URL

  /api/v1/roster/users/byingamename

• Method

  GET

• Query Parameters

  • name: The in-game name for which user data is to be fetched.

Response

• Success Response

  • Code: 200 OK

  • Content:

    {
        "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 ingame_name"
    }

  OR

  • Code: 404 Not Found

  • Content:

    {
        "error": "The user specified does not exist."
    }

• Sample Call

  GET https://api.arma.origin-development.net/api/v1/roster/users/byingamename?name=example

Notes

• This endpoint retrieves user data based on their in-game name.

• The in-game name is required as a query parameter.

• If no in-game name is provided or no user matches the specified name, appropriate error messages are returned.