Changes for page API V2.0

Last modified by Treyfane Dingo on 2024/03/10 02:07

From version 11.1
edited by Treyfane Dingo
on 2024/03/10 02:07
Change comment: There is no comment for this version
To version 10.1
edited by Treyfane Dingo
on 2024/02/11 19:43
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -20,10 +20,6 @@
20 20  |found|Returns all active (not returned) found items from the Lost & Found Database
21 21  |returned|Returns all inactive / returned items from the Lost & Found Database
22 22  |briefings| |Returns all briefings (i.e. Security News) classified as PUBLIC
23 -|(% colspan="1" rowspan="2" %)assets|checkout|Checks out an item described by data array
24 -|checkin|Checks in an item described by data array
25 -|(% colspan="1" rowspan="2" %)attendee|lockerservice|Returns Attendee Information described by data for the LockerService
26 -|onfl|Returns Attendee Information described by data for the OverNight Fursuit Locker
27 27  
28 28  The request "lostandfounddb" without a command will return the active Lost & Found Database entries for the respective Convention as a JSON. This includes Links to the uploaded images. Thus, the information can be processed on an external Website, e.g. the convention's homepage.
29 29  
... ... @@ -44,8 +44,7 @@
44 44  {{{ae629a834729fd3aac6d1f827b1793b2 Attendee Database
45 45  ae629a834729fd3aac6d1f827b1793b1 Operatives Database
46 46  ae629a834729fd3aac6d1f827b1793b0 Lost & Found Database
47 -ae629a834729fd3aac6d1f827b1793b3 Briefings Database
48 -ae629a834729fd3aac6d1f827b1793b4 Personal Assets Database}}}
43 +ae629a834729fd3aac6d1f827b1793b3 Briefings Database}}}
49 49  
50 50  === Output ===
51 51  
... ... @@ -137,75 +137,6 @@
137 137  |datetime_lastchange|ISO date|null
138 138  |datetime|ISO date which should be displayed. Is creation or lastchange whatever is bigger.|-
139 139  
140 -==== (% id="cke_bm_27662S" style="display:none" %) (%%)Personal Assets Database ====
141 -
142 -When giving a command to the Personal Assets Database, a data array has to be POSTed along with the request and command.
143 -
144 -(% style="width:955px" %)
145 -|(% colspan="3" style="width:182px" %)**Data Array**
146 -|(% style="width:182px" %)**Key**|(% colspan="2" rowspan="1" style="width:652px" %)**Field Content**
147 -|(% style="width:182px" %)ops_id|(% colspan="2" rowspan="1" style="width:652px" %)Numeric Value, Collar ID of the Operative
148 -|(% style="width:182px" %)attendee|(% colspan="2" rowspan="1" style="width:652px" %)Numeric Value, Attendee Badge ID
149 -|(% style="width:182px" %)type|(% colspan="2" rowspan="1" style="width:652px" %)Numeric Value, the id of the Personal Asset type
150 -|(% style="width:182px" %)serial|(% colspan="2" rowspan="1" style="width:652px" %)Text, the Serial Number of the Personal Asset
151 -
152 -{{box}}
153 -{
154 - "data":{
155 - "command":"checkin",
156 - "id":1715,
157 - "attendee":12,
158 - "type":"Donation Bag",
159 - "serial":"123456789",
160 - "out":"10.03.2024 02:51",
161 - "out_by":112,
162 - "in":"10.03.2024 02:51",
163 - "in_by":112
164 - }
165 -}
166 -{{/box}}
167 -
168 -(% style="width:50%" %)
169 -|=(% colspan="3" %)Personal Assets fieldset
170 -|=(% scope="col" %)Key|=Field|=NULL
171 -|command|Text, the originally issued command|-
172 -|id|Numeric Value, PRIMARY KEY|-
173 -|attendee|Numeric Value|-
174 -|type|Text|-
175 -|serial|Text|-
176 -|out|DE date|-
177 -|out_by|Numeric Value|-
178 -|in|DE date|NULL
179 -|in_by|Numeric Value|NULL
180 -
181 -==== (% id="cke_bm_301917S" style="display:none" %) (%%)Attendee Database ====
182 -
183 -When giving a command to the Personal Assets Database, a data payload has to be POSTed along with the request and command.
184 -
185 -(% style="width:955px" %)
186 -|(% style="width:182px" %)**Key**|(% colspan="2" rowspan="1" style="width:652px" %)**Field Content**
187 -|(% style="width:182px" %)data|(% colspan="2" rowspan="1" style="width:652px" %)Numeric Value, Attendee Badge ID
188 -
189 -{{box}}
190 -{
191 - "data": {
192 - "id": 1,
193 - "nick": "GLaDOS",
194 - "firstname": "Genetic Lifeform",
195 - "lastname": "and Disk Operating System",
196 - "checkletter": "A"
197 - }
198 -}
199 -{{/box}}
200 -
201 -(% style="width:50%" %)
202 -|=(% colspan="3" %)Attendee fieldset
203 -|=(% scope="col" %)Key|=Field|=NULL
204 -|id|Numeric Value, PRIMARY KEY|-
205 -|firstname|Text|-
206 -|lastname|Text|-
207 -|checkletter|Text|NULL
208 -
209 209  ==== Empty Object ====
210 210  
211 211  {{box}}
... ... @@ -233,7 +233,6 @@
233 233  |=(% colspan="3" %)Error Codes
234 234  |=(% scope="col" %)Code|=Message|=Description
235 235  |401|Unauthorized|API-Key is not correct or no API-Key provided.
236 -|422|Unprocessable Data|The data payload can not be processed due to an error
237 237  |500|Internal server error|Most likely the mySQL-Connection failed. A certain Dingo might be rather busy at this time.
238 238  |501|Bad or no request|Whatever you send, it wasn't a valid request.
239 239  |503|Maintenance Mode enabled - please try again later|Might follow an error 500 and the Dingo is still busy ...