Skip to content

Voting
Voting
Commit 4c877e41 authored by Matthieu - Greep's avatar Matthieu - Greep
Browse files
Options

Update README.md

parent 93974b59
Pipeline #464 passed with stage
    in 49 seconds
    Hide whitespace changes
    Inline Side-by-side
    Showing with 12 additions and 13 deletions
    README.md
    View file @ 4c877e41
    ......@@ -14,9 +14,9 @@ If you just want to call the REST-Server you can do it with: `https://tm-voting.
    **GET /getVotes**<br>
    Returns the current voting status for the current map.<br>
    | Parameter | Description | Example
    |------------ |------------------------------------- |-----------------------------
    | map | The map UID to show the votes on it | `OkNwgzSwDLZSWSRPsUKY7EA1Cg5`
    | Parameter | Type | Description | Example
    |------------ |------- |------------------------------------- |-----------------------------
    | map | String | The map UID to show the votes on it | `OkNwgzSwDLZSWSRPsUKY7EA1Cg5`
    Example response:
    ```json
    ......@@ -31,10 +31,10 @@ Example response:
    **GET /getPlayerVote**<br>
    Returns the current voting status of a player for the current map.<br>
    | Parameter | Description | Example
    |------------ |------------------------------------- |-----------------------------
    | map | The map UID to show the votes on it | `OkNwgzSwDLZSWSRPsUKY7EA1Cg5`
    | player | The player login that he voted on it | `Jtmn3kBnSSadky_mLNhp_A`
    | Parameter | Type | Description | Example
    |------------ |------- |------------------------------------- |-----------------------------
    | map | String | The map UID to show the votes on it | `OkNwgzSwDLZSWSRPsUKY7EA1Cg5`
    | player | String | The player login that he voted on it | `Jtmn3kBnSSadky_mLNhp_A`
    Example response:
    ```json
    ......@@ -81,13 +81,12 @@ Example response:
    **POST /setVote**<br>
    Writes the vote of a player to the respective map into the database table.<br />
    ⚠ You need an Authorization header with a valid token in order to do requests for this. After getting your token, set your Authorization value to `Basic yourtokenhere`
    | Parameter | Description | Example
    |------------ |------------------------------------- |-----------------------------
    | map | The map UID to vote | `OkNwgzSwDLZSWSRPsUKY7EA1Cg5`
    | player | The player login that it will vote | `Jtmn3kBnSSadky_mLNhp_A`
    | vote | A number between 0 and 100 to define the vote | `56`
    | Parameter | Type | Description | Example
    |------------ |------- |------------------------------------- |-----------------------------
    | map | String | The map UID to vote | `OkNwgzSwDLZSWSRPsUKY7EA1Cg5`
    | player | String | The player login that it will vote | `Jtmn3kBnSSadky_mLNhp_A`
    | vote | Number | A number between 0 and 100 to define the vote | `56`
    Example Response:
    ```json
    ......
    Markdown is supported
    0% or
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment