MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=voteny

(main | voteny)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: VoteNY
  • License: GPL-2.0-or-later

VoteNY API module

Parameters:
what

Action to take; valid values are 'vote' (green voting box), 'multi' (voting stars) or 'delete' (delete a previously given vote)

This parameter is required.
pageId

Page ID of the page where the voting box/stars is/are

This parameter is required.
Type: integer
voteValue

Numerical vote value between 1 and 5

Type: integer
type

Set this to 'stars' to call the voting stars (VoteStars PHP class), otherwise the green vote box (Vote PHP class) is used

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
Examples:
Cast a vote for the page which has the ID number 666
api.php?action=voteny&what=vote&pageId=666 [open in sandbox]
Delete your vote from the page which has the ID number 666
api.php?action=voteny&what=delete&pageId=666 [open in sandbox]
Cast a vote (3 stars out of 5) for the page which has the ID number 666
api.php?action=voteny&what=vote&type=stars&pageId=666&voteValue=3 [open in sandbox]
Delete your vote from the page which has the ID number 666 which is using the star rating
api.php?action=voteny&what=delete&type=stars&pageId=666 [open in sandbox]
Cast a vote (4 stars out of 5) for the page which has the ID number 666, deleting your previous vote, if any
api.php?action=voteny&what=multi&type=stars&pageId=666&voteValue=4 [open in sandbox]