matekasse/Website/templates/documentation.html

49 lines
1.8 KiB
HTML
Raw Normal View History

<html>
<head>
<title>Documentation</title>
<link rel="stylesheet" type="text/css" href="documentation.css">
<link rel="shortcut icon" type="Logo/png" href="ccc_logo.png"/>
</head>
<body>
<div id="Infos">
<p> <a href="/">index page</a> | <a href="/list">user and tag list</a></p>
<p><a href="https://hannover.ccc.de/gitlab/anton/matekasse">https://hannover.ccc.de/gitlab/anton/matekasse</a></p>
</div>
<h1 class="header"> <u>Documentation</u> </h1>
<p>&nbsp;</p>
<div id="text">
<h2>API:</h2>
2023-12-01 22:23:11 +00:00
<p>http://matekasse.server.c3h/api/tag_id</p>
<p>Post method "id"= tag id</p>
<p>Response:
{"mode":"error" "error":"{error}"} or
{"mode":"message","username":"{username}","message":"{message}"} or
{"mode":"balance", "username":"{username}", "balance":"{balance}"}
</p>
<br></br>
2023-12-01 22:23:11 +00:00
<p>http://matekasse.server.c3h/api/change</p>
<p>Post method "id" = user id, "change"=change</p>
<p>
If change = None or NaN the change will be -1
</p>
<p>
Response:
{"mode":"error" "error":"{error}"} or
{"mode":"balance", "username":"{username}", "balance":"{balance}"}
</p>
<br></br>
<h2>Error Codes:</h2>
<p>170: Tag already in use</p>
<p>054: Tag does not exists</p>
<p>757: User already exists</p>
<p>043: User does not exists</p>
<p>352: Timeout</p>
<p>095: Input is not a Number</p>
<P>418: I'm a teapot</P>
</div>
</body>
2023-07-28 21:30:45 +00:00
</html>