Skip to Content

Changes for page API V2.0

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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -API V1.0
1 +API V2.0
Parent
... ... @@ -1,1 +1,1 @@
1 -L\.A\.S\.S\.I\.E\..WebHome
1 +L\.A\.S\.S\.I\.E\..System Information.WebHome
Content
... ... @@ -1,6 +1,6 @@
1 -The L.A.S.S.I.E. API V 1.0 can be reached via
1 +The L.A.S.S.I.E. API V 2.0 can be reached via
2 2  
3 -{{{https://www.furcom.org/api/lassie/v1.0}}}
3 +{{{https://www.furcom.org/api/lassie/v2.0}}}
4 4  
5 5  === Required POST Parameters ===
6 6  
... ... @@ -10,11 +10,11 @@
10 10  * request
11 11  * command (optional)
12 12  
13 -The API-Key has to be set in "System Settings". Preferrably a longer and unique key (like a MD5SUM).
13 +The API-Key has to be set in "System Settings". Preferrably a longer and unique key (like a MD5SUM). An specific API key can only be used for a corresponding request type.
14 14  
15 -Requests and Commands
16 -
17 -|=Request|=Command|=Description
15 +(% style="width:50%" %)
16 +|=(% colspan="3" %)Requests and Commands
17 +|=(% scope="col" %)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
... ... @@ -25,11 +25,11 @@
25 25  
26 26  === Example (CURL) ===
27 27  
28 -{{{curl -X POST -d "apikey=ae629a834729fd3aac6d1f827b1793b0" -d "request=lostandfounddb" https://www.furcom.org/api/lassie/v1.0}}}
28 +{{{curl -X POST -d "apikey=ae629a834729fd3aac6d1f827b1793b0" -d "request=lostandfounddb" https://www.furcom.org/api/lassie/v2.0}}}
29 29  
30 30  This example will display the entire Lost & Found Database of FTC.
31 31  
32 -{{{curl -X POST -d "apikey=ae629a834729fd3aac6d1f827b1793b0" -d "request=lostandfounddb" -d "command=lost" https://www.furcom.org/api/lassie/v1.0}}}
32 +{{{curl -X POST -d "apikey=ae629a834729fd3aac6d1f827b1793b0" -d "request=lostandfounddb" -d "command=lost" https://www.furcom.org/api/lassie/v2.0}}}
33 33  
34 34  This example will display only the lost items of the Lost & Found Database of FTC.
35 35  
... ... @@ -39,13 +39,16 @@
39 39  
40 40  ==== Lost & Found Database ====
41 41  
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":""}]}}}}
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}}
43 43  
44 -Lost & Found fieldset
45 -
46 -|=Key|=Field|=NULL
46 +(% style="width:50%" %)
47 +|=(% colspan="3" %)Lost & Found fieldset
48 +|=(% scope="col" %)Key|=Field|=NULL
47 47  |id|Numeric value, PRIMARY KEY|-
48 48  |image|URL|null
51 +|thumb|URL|null
49 49  |title|Text|empty string
50 50  |description|Text|empty string
51 51  |status|L ~| F ~| R (Lost, Found or Returned)|-
... ... @@ -55,11 +55,13 @@
55 55  
56 56  ==== Briefings Database ====
57 57  
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"}]}}}}
61 +{{box}}
62 +{"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 +{{/box}}
59 59  
60 -Briefings fieldset
61 -
62 -|=Key|=Field|=NULL
65 +(% style="width:50%" %)
66 +|=(% colspan="3" %)Briefings fieldset
67 +|=(% scope="col" %)Key|=Field|=NULL
63 63  |id|Numeric value, PRIMARY KEY|-
64 64  |class|P (hopefully only P)|-
65 65  |topic|Text|empty string
... ... @@ -71,19 +71,23 @@
71 71  
72 72  ==== Empty Object ====
73 73  
74 -{{{{"data":[]}}}}
79 +{{box}}
80 +{"data":[]}
81 +{{/box}}
75 75  
76 76  === Error Codes ===
77 77  
78 78  The API will send a JSON-Object upon errors
79 79  
80 -{{{{"error":{"code":"503","message":"Maintenance Mode enabled - please try again later"}}}}}
87 +{{box}}
88 +{"error":{"code":"503","message":"Maintenance Mode enabled - please try again later"}}
89 +{{/box}}
81 81  
82 82  The following error codes are implemented:
83 83  
84 -Error Codes
85 -
86 -|=Code|=Message|=Description
93 +(% style="width:50%" %)
94 +|=(% colspan="3" %)Error Codes
95 +|=(% scope="col" %)Code|=Message|=Description
87 87  |401|Unauthorized|API-Key is not correct or no API-Key provided.
88 88  |500|Internal server error|Most likely the mySQL-Connection failed. A certain Dingo might be rather busy at this time.
89 89  |501|Bad or no request|Whatever you send, it wasn't a valid request.