Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
apidocs:maps [2017/03/26 - 04:16] thibmo created |
apidocs:maps [2018/08/22 - 16:10] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Maps ====== | ====== Maps ====== | ||
| + | This section describes the API calls that belong to the maps endpoint. | ||
| - | === Get all maps === | + | ===== Get All Maps ===== |
| - | Request : /api/v1/maps | + | Request : /api/v1/maps\\ |
| Method : GET | Method : GET | ||
| Line 34: | Line 35: | ||
| </code> | </code> | ||
| - | === Get maps for a user === | + | ===== Get Map Details ===== |
| - | Request : /api/v1/maps?user=‹id› | + | Request : /api/v1/maps/‹id›\\ |
| Method : GET | Method : GET | ||
| Line 42: | Line 43: | ||
| { | { | ||
| "status": "Ok", | "status": "Ok", | ||
| - | "data": [ | + | "data": { |
| - | { | + | "map_pk": integer, |
| - | "map_pk": integer, | + | "map_name": string, |
| - | "map_name": string, | + | "map_downloads": integer, |
| - | "map_downloads": integer, | + | "rev_map_description_short": string, |
| - | "rev_map_description_short": string, | + | "rev_map_description": string, |
| - | "user_name": string, | + | "rev_upload_date": string, |
| - | "map_type_name": string, | + | "user_name": string, |
| - | "avg_rating": float | + | "map_type_name": string, |
| - | }, | + | "avg_rating": float, |
| - | { | + | "rating_one": integer, |
| - | ... | + | "rating_two": integer, |
| - | } | + | "rating_three": integer, |
| - | ] | + | "rating_four": integer, |
| + | "rating_five": integer | ||
| + | } | ||
| } | } | ||
| </code> | </code> | ||
| Line 67: | Line 70: | ||
| </code> | </code> | ||
| - | === Get details about a specific map === | + | ===== Get Maps For User ===== |
| - | Request : /api/v1/maps/‹id› | + | Request : /api/v1/maps?user=‹id›\\ |
| Method : GET | Method : GET | ||
| Line 75: | Line 78: | ||
| { | { | ||
| "status": "Ok", | "status": "Ok", | ||
| - | "data": { | + | "data": [ |
| - | "map_pk": integer, | + | { |
| - | "map_name": string, | + | "map_pk": integer, |
| - | "map_downloads": integer, | + | "map_name": string, |
| - | "rev_map_description_short": string, | + | "map_downloads": integer, |
| - | "rev_map_description": string, | + | "rev_map_description_short": string, |
| - | "rev_upload_date": string, | + | "user_name": string, |
| - | "user_name": string, | + | "map_type_name": string, |
| - | "map_type_name": string, | + | "avg_rating": float |
| - | "avg_rating": float, | + | }, |
| - | "rating_one": integer, | + | { |
| - | "rating_two": integer, | + | ... |
| - | "rating_three": integer, | + | } |
| - | "rating_four": integer, | + | ] |
| - | "rating_five": integer | + | |
| - | } | + | |
| } | } | ||
| </code> | </code> | ||
