From Test-Scratch-Wiki


Example Request
Example Response

[edit] [history] [purge] Documentation Template documentation

This documentation is transcluded from Template:API request/doc.

This template is specifically for use on Scratch API (2.0).


{{API request|<description>|<URL>|<response>|<method =METHOD>}}


  1. The first parameter is a description of the request, e.g. its purpose.
  2. The second parameter is the URL of the request, e.g. for the API root request. Note that the URL MUST end with a slash (/).
  3. The third parameter is an example response to such a request. If there isn't really any response data available, simply put "(no response available)".
  • method: This named parameter specifies the HTTP method to use for the request. By default, this is GET; however, some Scratch API requests use PUT, so that is what this parameter is for.

See Scratch API (2.0) for example usage.