Update Website/templates/documentation.html #22

Merged
anton merged 1 commit from j3d1/matekasse:j3d1-patch-1 into master 2023-12-01 16:38:40 +00:00

View file

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