This is an old revision of the document!


Maps

Get all maps

Request : /api/v1/maps Method : GET

Successful response :

{
    "status": "Ok",
    "data": [
        {
            "map_pk": integer,
            "map_name": string,
            "map_downloads": integer,
            "rev_map_description_short": string,
            "user_name": string,
            "map_type_name": string,
            "avg_rating": float
        },
        {
            ...
        }
    ]
}

Failed response :

{
    "status": "Error",
    "message": string
}

Get maps for a user

Request : /api/v1/maps?user=‹id› Method : GET

Successful response :

{
    "status": "Ok",
    "data": [
        {
            "map_pk": integer,
            "map_name": string,
            "map_downloads": integer,
            "rev_map_description_short": string,
            "user_name": string,
            "map_type_name": string,
            "avg_rating": float
        },
        {
            ...
        }
    ]
}

Failed response :

{
    "status": "Error",
    "message": string
}

Get details about a specific map

Request : /api/v1/maps/‹id› Method : GET

Successful response :

{
    "status": "Ok",
    "data": {
        "map_pk": integer,
        "map_name": string,
        "map_downloads": integer,
        "rev_map_description_short": string,
        "rev_map_description": string,
        "rev_upload_date": string,
        "user_name": string,
        "map_type_name": string,
        "avg_rating": float,
        "rating_one": integer,
        "rating_two": integer,
        "rating_three": integer,
        "rating_four": integer,
        "rating_five": integer
    }
}

Failed response :

{
    "status": "Error",
    "message": string
}

apidocs/maps.1490494596.txt.gz · Last modified: 2018/08/22 - 16:10 (external edit)