API WIKI

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

Insert logging about new checkin device and returns info about the checkin location. This API is not necessary to use before checkin/out as the API's are stateless.

      /// <param name="token"></param>
      /// <param name="checkInPointId"></param>
      /// <param name="clientname"></param>
      /// <param name="ip"></param>
      /// <param name="version"></param>
      /// <param name="owner"></param>
      /// <param name="from"></param>

Return:

  public class Club
  {
      public ImageInfo Logo { get; set; }
      public string Culture { get; set; }
      public string Name { get; set; }
      public CheckInPoint CheckInPoint { get; set; }
      public string UnknownCardMessage { get; set; }
      public int Screensavertimer { get; set; }
  }        

Perform a check-In for a given UID, can be for a member or employee.

      /// <param name="token"></param>
      /// <param name="uid"></param>
      /// <param name="checkInPointId"></param>
      /// <param name="owner"></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>

Example: https://demo.clubplanner.be/api/CheckInApp/CheckIn?token=DEMOTOKEN&uid=A1B2C3D4&checkInPointId=1&owner=1

Return:

    
  class CheckInResult
  {
      public string Name { get; set; }
      public string FullName { get; set; }
      public ImageInfo Image { get; set; }
      public bool OpenGate { get; set; }
      public string CheckInMessage { get; set; }
      public int CheckInColor { get; set; }
      public int Id { get; set; }
      public string ErrorMessage { get; set; }
      public int SequenceNo { get; set; }
      public Clib.ClubPlanner.BusinessLayer.Member.CheckInResult CheckInResultId { get; set; }
      public string Type { get; set; }
  }
  

Performs a checkpout for a given UID, can be for a member or employee.

      /// <param name="token"></param>
      /// <param name="uid"></param>
      

Return:

  class CheckOutResult
  {
      public string FullName { get; set; }
      public int Id { get; set; }
      public string Type { get; set; }
  }
  

      /// <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”:

Setup listening page: https://demo.clubplanner.be/checkin/clientcheckin?ClubId=1&CheckinPointId=1&password=pass other example, same owner but other checkin-point: https://demo.clubplanner.be/checkin/clientcheckin?ClubId=1&CheckinPointId=2

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

Send text message to 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: 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.

https://demo.clubplanner.be/api/CheckInApp/checkin?token=DEMOTOKEN&uid=1&signal=1&picture=0