PonyMirrors/poll.horse
1
0
Fork 0
mirror of https://github.com/Wolvan/poll.horse.git synced 2024-11-24 21:57:59 +01:00
Code Issues Projects Releases Packages Wiki Activity
poll.horse/API.md
Wolvan cfa150cc42 Move API and document it 
The API has been moved to a /api path to distinguish it from the form
submission path and make it clear it is a callable API.
The API also has been rudimentarily documented.
2022-01-12 21:11:09 +01:00

2.6 KiB
Raw Blame History

API

API URL

The base URL for all API calls is /_backend/api.



Get poll information

Fetch JSON data of a single poll defined by the poll ID string.

  • URL

    /poll/:id

  • Method:

    GET

  • URL Params

    Required:

    id=[alphanumeric]

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content: 
      {
    "id": "abcd1234",
    "title": "An API requested Poll",
    "dupeCheckMode": "ip",
    "multiSelect": true,
    "creationTime": "2022-01-12T19:26:37.262Z",
    "options": [
        "Option A",
        "Option B",
        "Option C"
    ]
}

  • Error Response:

    • Code: 404 NOT FOUND
      Content: 
      {
    "error" : "Poll not found"
}

    OR

    • Code: 500 INTERNAL SERVER ERROR
      Content: 
      {
    "error" : "<ERROR_MESSAGE_STRING>"
}

Get poll result

Fetch JSON data of the result of a single poll defined by the poll ID string.

  • URL

    /poll-result/:id

  • Method:

    GET

  • URL Params

    Required:

    id=[alphanumeric]

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content: 
      {
    "title": "An API requested Poll",
    "options": {
        "Option A": 0,
        "Option B": 3,
        "Option C": 1
    }
}

  • Error Response:

    • Code: 404 NOT FOUND
      Content: 
      {
    "error" : "Poll not found"
}

    OR

    • Code: 500 INTERNAL SERVER ERROR
      Content: 
      {
    "error" : "<ERROR_MESSAGE_STRING>"
}

Create a poll

Create a new poll and return its id

  • URL

    /poll

  • Method:

    POST

  • URL Params

    None

  • Data Params

    Required:

    options=[string][]

    Optional:

    title=[alphanumeric]

    dupeCheckMode="ip" | "cookie" | "none"

    multiSelect=[boolean]

  • Success Response:

    • Code: 200
      Content: 
      {
    "id": "abcd1234"
}

  • Error Response:

    • Code: 400 BAD REQUEST
      Content: 
      {
    "error" : "<ERROR_MESSAGE_STRING>"
}
      Possible Error Messages:
      • Options must be an array and have at least 2 different entries
      • Only <<MAX_POLL_OPTIONS>> options are allowed

    OR

    • Code: 500 INTERNAL SERVER ERROR
      Content: 
      {
    "error" : "<ERROR_MESSAGE_STRING>"
}