User Tools

Site Tools


checkin

This is an old revision of the document!


CheckinApp.Connect

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; }
  }        

CheckinApp.CheckIn

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>

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; }
  }
  

CheckinApp.CheckOut

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; }
  }
  

Notification.SignalCheckIn

Sends the checkin to any listening clientcheckin page on that club-id and display-id. Example listening page, use password: “pass”:

Setup listening page: https://demo.clubplanner.be/checkin/clientcheckin?ClubId=1&CheckinPointId=1 other example, same owner but other checkin-point: 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: 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: https://demo.clubplanner.be/api/Notification/SignalCheckIn?token=DEMOTOKEN&data=test123&from=me&owner=1&checkinpointid=1

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

Send checkin-result to clientcheckin page: (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.1546188322.txt.gz · Last modified: 2018/12/30 18:45 (external edit)