Get information on a given OKAPI service method :: services/apiref/method method
|
|
|
http://www.opencaching.us/okapi/services/apiref/method
|
|
This method allows you to access API documentation (the same which you
are reading just now). Given a method name, it returns a complete method description.
|
| name |
required |
Name of a method (begins with "services/").
|
| format |
optional |
Standard common formatting argument. |
| callback |
optional |
Standard common formatting argument. |
|
No additional authentication parameters are required.
|
|
Returned value:
A dictionary of the following structure:
- name - name of the method,
- short_name - name without a path,
- issue_id - ID of the "general discussion" issue (in our project's
homepage Issue Tracker) associated with this method or null if this
method has associated issue,
- description - HTML-formatted description of what the method does,
- brief_description - brief (max 80 characters), single-line,
plain-text description of what the method does,
- ref_url - URL of the documentation page with method description,
-
auth_options - a dictionary which describes authentication
requirements for this method, it has a following structure:
- min_auth_level - integer, in range from 0 to 3,
see Introduction page.
- oauth_consumer - "required" when min_auth_level >= 2,
"optional" otherwise,
- oauth_token - "required" when min_auth_level == 3,
"optional" otherwise.
- arguments - list of dictionaries, describes method
arguments. Each dictionary has a following structure:
- name - name of an argument,
- is_required - boolean, true if the argument is required,
- description - HTML-formatted description of an argument.
-
class - one of the following values: public,
inherited or common-formatting (other values might be
introduced in future).
Currently these values do not mean anything specific. They are
used for different coloring/styling in the documentation pages.
- returns - HTML-formatted description method's return value.
|
|