API WIKI

User Tools

Site Tools

Trace:
checkin

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
checkin [2018/12/30 17:44]
clubadmin [Notification.SignalCheckIn] 		checkin [2023/10/16 14:11] (current)
Line 1: Line 1:
 +===== CheckinApp.QRCode===== 
 +Return a QRcode-string for a member, can be used in 3th party apps.
 +        /// <param name="token"></param>
 +        /// <param name="id">numeric id of the member</param>
 +        
 +Example:
 +https://demo.clubplanner.be/api/checkinapp/QRCode?token=DEMOTOKEN&id=1
 +
 ===== CheckinApp.Connect=====  ===== CheckinApp.Connect===== 
  
Line 31: Line 39:
         /// <param name="owner"></param>         /// <param name="owner"></param>
         /// <param name="picture">optional, set to 0 and will not include picture hash</param>         /// <param name="picture">optional, set to 0 and will not include picture hash</param>
 +        /// <param name="signal">optional, set to 1 and will signal any listeners/param>
  
          
Line 73: Line 82:
 ===== Notification.SignalCheckIn=====  ===== Notification.SignalCheckIn===== 
  
-Sends the checkin to any listening clientcheckin page on that club-id and display-id.+        /// <param name="token"></param> 
 +        /// <param name="data"></param> 
 +        /// <param name="from"></param> 
 +        /// <param name="owner"></param> 
 +        /// <param name="checkinpointid"></param> 
 +        /// <param name="password">optional, provide web functions password (no popup anymore the first time)</param> 
 +         
 +Sends a signal to any client-checkin page on that is listening to the same club-id and display-id.
 Example listening page, use password: "pass": Example listening page, use password: "pass":
  
 Setup listening page: Setup listening page:
-https://demo.clubplanner.be/checkin/clientcheckin?ClubId=1&CheckinPointId=1+https://demo.clubplanner.be/checkin/clientcheckin?ClubId=1&CheckinPointId=1&password=pass
 other example, same owner but other checkin-point: other example, same owner but other checkin-point:
 https://demo.clubplanner.be/checkin/clientcheckin?ClubId=1&CheckinPointId=2 https://demo.clubplanner.be/checkin/clientcheckin?ClubId=1&CheckinPointId=2
  
-Settings (password + owner + checkinare saved in cookie, after the first time you can just open:+Password + owner + checkin are saved in a cookie, after the first time you can just open the link without any parameters:
 https://demo.clubplanner.be/checkin/clientcheckin https://demo.clubplanner.be/checkin/clientcheckin
  
-        /// <param name="token"></param> +
-        /// <param name="data"></param> +
-        /// <param name="from"></param> +
-        /// <param name="owner"></param> +
-        /// <param name="checkinpointid"></param>+
                  
 Send text message to owner 1/checkinpointid 1: Send text message to owner 1/checkinpointid 1:
-https://demo.clubplanner.be/api/Notification/SignalCheckIn?token=DEMOTOKEN&data=test123&from=me&owner=1&checkinpointid=1+https://demo.clubplanner.be/api/Notification/SignalCheckIn?token=DEMOTOKEN&data=hello1&from=me&owner=1&checkinpointid=1
            
 Send text message to owner 1/checkinpointid 2: Send text message to owner 1/checkinpointid 2:
-https://demo.clubplanner.be/api/Notification/SignalCheckIn?token=DEMOTOKEN&data=test123&from=me&owner=1&checkinpointid=2+https://demo.clubplanner.be/api/Notification/SignalCheckIn?token=DEMOTOKEN&data=hello2&from=me&owner=1&checkinpointid=2 
 + 
 +Send text message to all clientcheckin pages: 
 +https://demo.clubplanner.be/api/Notification/SignalCheckIn?token=DEMOTOKEN&data=hellotoall&from=me 
 + 
 +Send checkin-result to clientcheckin page: 
 +(set data parameter to checkin result) 
 +data:{"Name":"Jane","FullName":"Jane Johanson","Image":null,"OpenGate":true,"CheckInMessage":"Abonnement doorlopend geldig","CheckInColor":-7278960,"CheckInColorHex":"LightGreen","Id":1,"ErrorMessage":"Success","SequenceNo":250844,"CheckInResultId":0,"Type":"MEMBER"} 
 + 
 +Other option, let the checkin API itself signal the checkin.  
 +This could affect speed of opening gate, so please be careful with this.
  
-__Send checkin-result to clientcheckin page__ +https://demo.clubplanner.be/api/CheckInApp/checkin?token=DEMOTOKEN&uid=1&signal=1&picture=0
-set data parameter to checkin result: +
-{"Name":"Jane","FullName":"Jane Johanson","Image":null,"OpenGate":true,"CheckInMessage":"Abonnement doorlopend geldig","CheckInColor":-7278960,"CheckInColorHex":"LightGreen","Id":1,"ErrorMessage":"Success","SequenceNo":250844,"CheckInResultId":0,"Type":"MEMBER"}+
  
checkin.1546188298.txt.gz · Last modified: 2018/12/30 18:44 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki