Files
oc-server3/htdocs/okapi/services/apiref/issue.xml
2014-10-08 10:06:07 +02:00

33 lines
1.6 KiB
XML

<xml>
<brief>Retrieve information on given issue</brief>
<issue-id>11</issue-id>
<desc>
<p><b>Important:</b> This method stopped working properly in October 2013.
Now, it returns a simple placeholder.
<a href='https://code.google.com/p/opencaching-api/issues/detail?id=288'>Read more</a>.</p>
<p>OKAPI is trying to be as <b>integrated</b> with its
<a href='http://code.google.com/p/opencaching-api/'>Main Project Page</a> as it can.
This method retrieves basic information on a given issue from our project
<a href='http://code.google.com/p/opencaching-api/issues/list'>Issue Tracker</a>.
In future, it <b>might</b> also return some of the latest comments (we're not yet
sure if we want them displayed on our documentation pages).</p>
</desc>
<req name='issue_id'>
ID of an Issue.
</req>
<common-format-params/>
<returns>
<p>A dictionary of the following structure:</p>
<ul>
<li><b>id</b> - number of the issue created for this method,</li>
<li><b>last_updated</b> - date and time (ISO 8601) when the issue was last updated
<b>or null</b> if unknown,</li>
<li><b>title</b> - issue title <b>or null</b> if unknown,</li>
<li><b>url</b> - URL of the issue page,</li>
<li><b>comment_count</b> - total number of submitted comments <b>or null</b> if unknown.</li>
</ul>
<p>Note, that this will respond with HTTP 400 if we fail to retrieve data from
the Google Code site.</p>
</returns>
</xml>