Changes for page API V2.0

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

From 9.1 to 8.1

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 9.1

edited by Treyfane Dingo
on 2024/02/11 19:41

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -20,10 +20,6 @@
  |found|Returns all active (not returned) found items from the Lost & Found Database
  |returned|Returns all inactive / returned items from the Lost & Found Database
  |briefings| |Returns all briefings (i.e. Security News) classified as PUBLIC
--|(% colspan="1" rowspan="2" %)assets|checkout|Checks out an item described by data array
--|checkin|Checks in an item described by data array
--|(% colspan="1" rowspan="2" %)attendee|lockerservice|Returns Attendee Information described by data for the LockerService
--|onfl|Returns Attendee Information described by data for the OverNight Fursuit Locker
  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.
@@ -44,8 +44,7 @@
  {{{ae629a834729fd3aac6d1f827b1793b2    Attendee Database
  ae629a834729fd3aac6d1f827b1793b1    Operatives Database
  ae629a834729fd3aac6d1f827b1793b0    Lost & Found Database
--ae629a834729fd3aac6d1f827b1793b3    Briefings Database
--ae629a834729fd3aac6d1f827b1793b4    Personal Assets Database}}}
++ae629a834729fd3aac6d1f827b1793b3    Briefings Database}}}
  === Output ===
@@ -54,43 +54,7 @@
  ==== Lost & Found Database ====
  {{box}}
--{
--  "data": [
--    {
--      "id": 1925,
--      "image": null,
--      "thumb": null,
--      "title": "Image",
--      "description": "invisible, watercolour, found in Schroedinger's box",
--      "status": "F",
--      "lost_timestamp": null,
--      "found_timestamp": "2023-11-24 00:27:24",
--      "return_timestamp": null
--    },
--    {
--      "id": 1921,
--      "image": "https:~/~/api.lassie.furcom.org/images/lostandfound_db/fe3c6670a33d8f4199ffa95a5c23b622.png",
--      "thumb": "https:~/~/api.lassie.furcom.org/images/lostandfound_db/thumbnail/fe3c6670a33d8f4199ffa95a5c23b622.png",
--      "title": "Sense of Taste",
--      "description": "lost in Hotel Restaurant",
--      "status": "L",
--      "lost_timestamp": "2023-11-01 16:13:02",
--      "found_timestamp": null,
--      "return_timestamp": null
--    },
--    {
--      "id": 1920,
--      "image": "https:~/~/api.lassie.furcom.org/images/lostandfound_db/bc7c343fb3807d4d41b7e04fa909aad5.png",
--      "thumb": "https:~/~/api.lassie.furcom.org/images/lostandfound_db/thumbnail/bc7c343fb3807d4d41b7e04fa909aad5.png",
--      "title": "Vape",
--      "description": "black / rainbow, \"GEEKVAPE\", found at Open Stage",
--      "status": "F",
--      "lost_timestamp": null,
--      "found_timestamp": "2023-09-30 23:52:38",
--      "return_timestamp": null
--    }
--  ]
--}
++{"data":[{"id":1925,"image":null,"thumb":null,"title":"Image","description":"invisible, watercolour, found in Schroedinger's box","status":"F","lost_timestamp":null,"found_timestamp":"2023-11-24 00:27:24","return_timestamp":null},{"id":1921,"image":"https:\/\/api.lassie.furcom.org\/images\/lostandfound_db\/fe3c6670a33d8f4199ffa95a5c23b622.png","thumb":"https:\/\/api.lassie.furcom.org\/images\/lostandfound_db\/thumbnail\/fe3c6670a33d8f4199ffa95a5c23b622.png","title":"Sense of Taste","description":"lost in Hotel Restaurant","status":"L","lost_timestamp":"2023-11-01 16:13:02","found_timestamp":null,"return_timestamp":null},{"id":1920,"image":"https:\/\/api.lassie.furcom.org\/images\/lostandfound_db\/bc7c343fb3807d4d41b7e04fa909aad5.png","thumb":"https:\/\/api.lassie.furcom.org\/images\/lostandfound_db\/thumbnail\/bc7c343fb3807d4d41b7e04fa909aad5.png","title":"Vape","description":"black \/ rainbow, \"GEEKVAPE\", found at Open Stage","status":"F","lost_timestamp":null,"found_timestamp":"2023-09-30 23:52:38","return_timestamp":null}]}
  {{/box}}
  (% style="width:50%" %)
@@ -109,20 +109,7 @@
  ==== Briefings Database ====
  {{box}}
--{
--  "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 neighbour?\"</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"
--    }
--  ]
--}
++{"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 neighbour?\"<\/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"}]}
  {{/box}}
  (% style="width:50%" %)
@@ -137,81 +137,10 @@
  |datetime_lastchange|ISO date|null
  |datetime|ISO date which should be displayed. Is creation or lastchange whatever is bigger.|-
--==== (% id="cke_bm_27662S" style="display:none" %) (%%)Personal Assets Database ====
--
--When giving a command to the Personal Assets Database, a data array has to be POSTed along with the request and command.
--
--(% style="width:955px" %)
--|(% colspan="3" style="width:182px" %)**Data Array**
--|(% style="width:182px" %)**Key**|(% colspan="2" rowspan="1" style="width:652px" %)**Field Content**
--|(% style="width:182px" %)ops_id|(% colspan="2" rowspan="1" style="width:652px" %)Numeric Value, Collar ID of the Operative
--|(% style="width:182px" %)attendee|(% colspan="2" rowspan="1" style="width:652px" %)Numeric Value, Attendee Badge ID
--|(% style="width:182px" %)type|(% colspan="2" rowspan="1" style="width:652px" %)Numeric Value, the id of the Personal Asset type
--|(% style="width:182px" %)serial|(% colspan="2" rowspan="1" style="width:652px" %)Text, the Serial Number of the Personal Asset
--
--{{box}}
--{
--  "data":{
--    "command":"checkin",
--    "id":1715,
--    "attendee":12,
--    "type":"Donation Bag",
--    "serial":"123456789",
--    "out":"10.03.2024 02:51",
--    "out_by":112,
--    "in":"10.03.2024 02:51",
--    "in_by":112
--  }
--}
--{{/box}}
--
--(% style="width:50%" %)
--|=(% colspan="3" %)Personal Assets fieldset
--|=(% scope="col" %)Key|=Field|=NULL
--|command|Text, the originally issued command|-
--|id|Numeric Value, PRIMARY KEY|-
--|attendee|Numeric Value|-
--|type|Text|-
--|serial|Text|-
--|out|DE date|-
--|out_by|Numeric Value|-
--|in|DE date|NULL
--|in_by|Numeric Value|NULL
--
--==== (% id="cke_bm_301917S" style="display:none" %) (%%)Attendee Database ====
--
--When giving a command to the Personal Assets Database, a data payload has to be POSTed along with the request and command.
--
--(% style="width:955px" %)
--|(% style="width:182px" %)**Key**|(% colspan="2" rowspan="1" style="width:652px" %)**Field Content**
--|(% style="width:182px" %)data|(% colspan="2" rowspan="1" style="width:652px" %)Numeric Value, Attendee Badge ID
--
--{{box}}
--{
--  "data": {
--    "id": 1,
--    "nick": "GLaDOS",
--    "firstname": "Genetic Lifeform",
--    "lastname": "and Disk Operating System",
--    "checkletter": "A"
--  }
--}
--{{/box}}
--
--(% style="width:50%" %)
--|=(% colspan="3" %)Attendee fieldset
--|=(% scope="col" %)Key|=Field|=NULL
--|id|Numeric Value, PRIMARY KEY|-
--|firstname|Text|-
--|lastname|Text|-
--|checkletter|Text|NULL
--
  ==== Empty Object ====
  {{box}}
--{
--  "data": []
--}
++{"data":[]}
  {{/box}}
  === Error Codes ===
@@ -219,12 +219,7 @@
  The API will send a JSON-Object upon errors
  {{box}}
--{
--  "error": {
--    "code": "503",
--    "message": "Maintenance Mode enabled - please try again later"
--  }
--}
++{"error":{"code":"503","message":"Maintenance Mode enabled - please try again later"}}
  {{/box}}
  The following error codes are implemented:
@@ -233,7 +233,6 @@
  |=(% colspan="3" %)Error Codes
  |=(% scope="col" %)Code|=Message|=Description
  |401|Unauthorized|API-Key is not correct or no API-Key provided.
--|422|Unprocessable Data|The data payload can not be processed due to an error
  |500|Internal server error|Most likely the mySQL-Connection failed. A certain Dingo might be rather busy at this time.
  |501|Bad or no request|Whatever you send, it wasn't a valid request.
  |503|Maintenance Mode enabled - please try again later|Might follow an error 500 and the Dingo is still busy ...