Skip to Content

Changes for page API V2.0

Last modified by Treyfane Dingo on 2024/03/10 02:07
From version 1.3
edited by Treyfane Dingo
on 2023/05/27 01:27
Change comment: There is no comment for this version
To version 1.1
edited by Treyfane Dingo
on 2023/05/27 01:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -12,9 +12,9 @@
12 12  
13 13  The API-Key has to be set in "System Settings". Preferrably a longer and unique key (like a MD5SUM).
14 14  
15 -(% style="width:50%" %)
16 -|=(% colspan="3" %)Requests and Commands
17 -|=(% scope="col" %)Request|=Command|=Description
15 +Requests and Commands
16 +
17 +|=Request|=Command|=Description
18 18  |(% rowspan="4" %)lostandfounddb|lostandfound|(Default) Returns all active (not returned) lost & found items from the Lost & Found Database
19 19  |lost|Returns all active (not returned) lost items from the Lost & Found Database
20 20  |found|Returns all active (not returned) found items from the Lost & Found Database
... ... @@ -39,13 +39,11 @@
39 39  
40 40  ==== Lost & Found Database ====
41 41  
42 -{{box}}
43 -{"data":[{"id":"1","image":"https:\/\/www.furcom.org\/lassie\/images\/lostandfound_db\/9a7a1039bcbe887ed2f57a5b64c56c51.png","title":"A Piece of Cake","description":"Just another piece of cake","status":"F","lost_timestamp":"","found_timestamp":"2021-06-22 19:08:16","return_timestamp":""}]}
44 -{{/box}}
42 +{{{{"data":[{"id":"1","image":"https:\/\/www.furcom.org\/lassie\/images\/lostandfound_db\/9a7a1039bcbe887ed2f57a5b64c56c51.png","title":"A Piece of Cake","description":"Just another piece of cake","status":"F","lost_timestamp":"","found_timestamp":"2021-06-22 19:08:16","return_timestamp":""}]}}}}
45 45  
46 -(% style="width:50%" %)
47 -|=(% colspan="3" %)Lost & Found fieldset
48 -|=(% scope="col" %)Key|=Field|=NULL
44 +Lost & Found fieldset
45 +
46 +|=Key|=Field|=NULL
49 49  |id|Numeric value, PRIMARY KEY|-
50 50  |image|URL|null
51 51  |title|Text|empty string
... ... @@ -57,13 +57,11 @@
57 57  
58 58  ==== Briefings Database ====
59 59  
60 -{{box}}
61 -{"data":[{"id":"17","class":"P","topic":"UPDATE - Security News 21.12.2021","content":"<div id=\"briefing_content_content\"><div><b>Germany cancelled New Years Eve<\/b><\/div><div>Although it might calendar wise be unwise, Germany just cancelled New Years Eve. Further information can be obtained elsewhere.<\/div><div><br><\/div><div><b>Some things found<\/b><\/div><div>Security\r\n wants to remind all attendees that information about lost or found \r\nitems can be obtained via the APP or the Website of the convention. Lost\r\n &amp; Found is maintained by security and located in the security \r\noffice.<\/div><div><br><\/div><div><b>Quote of the day<\/b><\/div><div>\"Where is your neighbor?\"<\/div><div>\"He's in the garden ...\"<\/div><div>\"I can't see him ...\"<\/div><div>\"Oh, you'd have to dig quite a bit ...\"<br><\/div><div><br><\/div><\/div>","ops_id":"112","datetime_creation":"2021-12-21 22:19:45","datetime_lastchange":"","datetime":"2021-12-21 22:19:45"}]}
62 -{{/box}}
58 +{{{{"data":[{"id":"17","class":"P","topic":"UPDATE - Security News 21.12.2021","content":"<div id=\"briefing_content_content\"><div><b>Germany cancelled New Years Eve<\/b><\/div><div>Although it might calendar wise be unwise, Germany just cancelled New Years Eve. Further information can be obtained elsewhere.<\/div><div><br><\/div><div><b>Some things found<\/b><\/div><div>Security\r\n wants to remind all attendees that information about lost or found \r\nitems can be obtained via the APP or the Website of the convention. Lost\r\n &amp; Found is maintained by security and located in the security \r\noffice.<\/div><div><br><\/div><div><b>Quote of the day<\/b><\/div><div>\"Where is your neighbor?\"<\/div><div>\"He's in the garden ...\"<\/div><div>\"I can't see him ...\"<\/div><div>\"Oh, you'd have to dig quite a bit ...\"<br><\/div><div><br><\/div><\/div>","ops_id":"112","datetime_creation":"2021-12-21 22:19:45","datetime_lastchange":"","datetime":"2021-12-21 22:19:45"}]}}}}
63 63  
64 -(% style="width:50%" %)
65 -|=(% colspan="3" %)Briefings fieldset
66 -|=(% scope="col" %)Key|=Field|=NULL
60 +Briefings fieldset
61 +
62 +|=Key|=Field|=NULL
67 67  |id|Numeric value, PRIMARY KEY|-
68 68  |class|P (hopefully only P)|-
69 69  |topic|Text|empty string
... ... @@ -75,23 +75,19 @@
75 75  
76 76  ==== Empty Object ====
77 77  
78 -{{box}}
79 -{"data":[]}
80 -{{/box}}
74 +{{{{"data":[]}}}}
81 81  
82 82  === Error Codes ===
83 83  
84 84  The API will send a JSON-Object upon errors
85 85  
86 -{{box}}
87 -{"error":{"code":"503","message":"Maintenance Mode enabled - please try again later"}}
88 -{{/box}}
80 +{{{{"error":{"code":"503","message":"Maintenance Mode enabled - please try again later"}}}}}
89 89  
90 90  The following error codes are implemented:
91 91  
92 -(% style="width:50%" %)
93 -|=(% colspan="3" %)Error Codes
94 -|=(% scope="col" %)Code|=Message|=Description
84 +Error Codes
85 +
86 +|=Code|=Message|=Description
95 95  |401|Unauthorized|API-Key is not correct or no API-Key provided.
96 96  |500|Internal server error|Most likely the mySQL-Connection failed. A certain Dingo might be rather busy at this time.
97 97  |501|Bad or no request|Whatever you send, it wasn't a valid request.