API WIKI

User Tools

Site Tools

Trace:
general

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
general [2018/02/17 11:47]
clubadmin [General.GetCheckInPoint] 		general [2022/03/29 22:00] (current)
Line 1: Line 1:
 +===== Home.WakeUp=====
 +
 +Returns a text and makes sure the website is up.
 +
 +https://demo.clubplanner.be/Home/WakeUp/1
 +
 ===== General.GetClubs ===== ===== General.GetClubs =====
  
Line 11: Line 17:
 Result: Result:
  
-[{"Id":1,"Name":"Demo","AddressLine":"Molenstraat 1","City":"Brussel","Zip":"1000","EMail":"info@test.be"},{"Id":2,"Name":"Demo Club 2","AddressLine":"Langeweg 123","City":"Antwerpen","Zip":"2000","EMail":"info@test.be"}]+[{"Id":1,"Name":"Demo Brussels","AddressLine":"Molenstraat 1","City":"Brussel","Zip":"1000","EMail":"info@clubplanner.be","Region":"","Classification":"","IsClubOpenType":0},{"Id":2,"Name":"Demo Paris","AddressLine":"Rue Mac Mahon","City":"Paris","Zip":"2000","EMail":"info@test.be","Region":"","Classification":""},{"Id":3,"Name":"Demo New York","AddressLine":"6th Avenue","City":"New York","Zip":"90210","EMail":"info@democlub.be","Region":"","Classification":"","IsClubOpenType":0}]
  
 ===== General.GetClub ===== ===== General.GetClub =====
 +
 Method: general/GetClub Method: general/GetClub
-/// <param name="token"></param> +
-/// <param name="id"></param>+
 Get the properties of a given club Get the properties of a given club
  
-Example: +        /// <param name="token"></param> 
-https://demo.clubplanner.be/api/general/GetClub?token=DEMOTOKEN&id=1+        /// <param name="id"></param>
  
 +
 +Example: https://demo.clubplanner.be/api/general/GetClub?token=DEMOTOKEN&id=1
 +
 +Result:
 +
 +{"Id":1,"Name":"Demo Brussels","AddressLine":"Molenstraat 1","City":"Brussel","Zip":"1000","EMail":"info@clubplanner.be","Region":"","Classification":"","IsClubOpenType":0}
 +
 +
 +//Note: IsClubOpenType:
 +
 +  * Open = 0,
 +  * Holiday = 1
 +  * NotInHours = 2
 +//
  
 ===== General.GetCheckInPoint ===== ===== General.GetCheckInPoint =====
Line 27: Line 47:
 Get the properties of a given checkinpoint Get the properties of a given checkinpoint
  
-/// <param name="token"></param> +        /// <param name="token"></param> 
-/// <param name="id"></param>+        /// <param name="id"></param>
  
  
  
-Example: +Example: https://demo.clubplanner.be/api/general/GetClub?token=DEMOTOKEN&id=1
-https://demo.clubplanner.be/api/general/GetClub?token=DEMOTOKEN&id=1+
  
  
 +===== General.GetPaymentMethods =====
  
 +Method: general/GetPaymentMethods
 +
 +Get all payment methods
 +
 +        /// <param name="token"></param>        
 +
 +
 +Example: https://demo.clubplanner.be/api/general/GetPaymentMethods?token=DEMOTOKEN
 +
 +Result:
 +
 +[{"Id":5,"Description":"Bancontact"},{"Id":11,"Description":"Cadeaucheque"},{"Id":1,"Description":"Cash"},{"Id":4,"Description":"Domiciliering"},{"Id":16,"Description":"MAESTRO"},{"Id":15,"Description":"MASTERCARD"},{"Id":3,"Description":"Overschrijving"},{"Id":12,"Description":"Sportcheque"},{"Id":13,"Description":"Via Factuur"},{"Id":14,"Description":"VISA"},{"Id":17,"Description":"VISA DEBET"}]
 +
 +
 +===== General.GetParameter =====
 +
 +Method: general/GetParameter
 +
 +Get the properties of a given parameter
 +        /// <param name="token"></param>
 +        /// <param name="parameter"></param>
 +        /// <param name="ownerid"></param>     
 +
 +
 +Example: https://demo.clubplanner.be/api/general/GetParameter?token=DEMOTOKEN&parameter=club_culture&ownerid=1
 +
 +Result:
 +
 +{"Name":"club_culture","Value":"EN"}
 +
 +===== General.UpdateParameter =====
 +
 +Method: general/UpdateParameter
 +
 +Update the value of given parameter
 +        /// <param name="token"></param>
 +        /// <param name="parameter"></param>
 +        /// <param name="value"></param>
 +        /// <param name="owner_id"></param>     
 +
 +
 +Example: https://demo.clubplanner.be/api/general/GetParameter?token=DEMOTOKEN&parameter=club_culture&value=EN&owner_id=1
 +
 +
 +===== General.GetHtml =====
 +
 +Method: general/GetHtml
 +
 +Get the properties  of a given ID
 +
 +        /// <param name="token"></param>
 +        /// <param name="aId"></param>         
 +
 +
 +Example: https://demo.clubplanner.be/api/general/GetHtml?token=DEMOTOKEN&aId=app_home
 +
 +Result:
 +
 +{"Name":"app_home","Value":"<!DOCTYPE html>\n<html lang=\"en\" >\n<head>\n  <meta charset=\"UTF-8\">\n  <script src=\"https://demo.clubplanner.be/App/js/modernizr.min.js\" type=\"text/javascript\"></script>\n<link href=\"https://fonts.googleapis.com/css?family=Dosis\" rel=\"stylesheet\" type=\"text/css\">\n    <link rel=\"stylesheet\" href=\"https://demo.clubplanner.be/App/css/normalize.min.css\">\n    <link rel=\"stylesheet\" href=\"https://demo.clubplanner.be/App/css/style.css\">\n</head>\n<body>  \n<div class=\"wrap\">\n  <h1 class=\"headline\">Club Planner\n    <div class=\"slash\"></div>\n  </h1>\n</div>\n</body>\n</html>\n"}
 +
 +
 +===== General.GetEmail =====
 +
 +Method: general/GetEmail
 +
 +Get the properties of a given message
 +
 +        /// <param name="token"></param>
 +        /// <param name="message_id"></param>        
 +
 +
 +Example: https://demo.clubplanner.be/api/general/GetEmail?token=DEMOTOKEN&message_id=129
 +
 +Result:
 +
 +{"Id":129,"Subject":"E-ID laten inlezen (SMS)","Description":"Beste @[MEMBERFIRSTNAME]@, Gelieve bij uw volgende bezoek uw elektronische identiteitskaart te laten inlezen, ter activatie van uw lidkaart."}
 +
 +
 +===== General.GetImage=====
 +
 +Method: general/GetImage
 +
 +Get the properties of a given image
 +
 +        /// <param name="token"></param>
 +        /// <param name="type"></param>
 +        /// <param name="data"></param>
 +        /// <param name="format"></param>
 +        /// <param name="scale"></param>
 +        
 +Example: https://demo.clubplanner.be/api/general/GetImage?token=DEMOTOKEN&type=option&data=1&format=gif&scale=0.25
 +
 +===== General.UrlEncryptData=====
 +
 +Encrypt a URL querystring using RSA encryption.
 +        /// <param name="token"></param>
 +        /// <param name="input">string</param>
 +        
 +https://demo.clubplanner.be/api/general/UrlEncryptData?token=DEMOTOKEN&input=my_data_to_be_encrypted
 +
 +===== General.UrlDecryptData=====
 +
 +Decrypt a URL querystring using RSA encryption.
 +
 +        /// <param name="token"></param>
 +        /// <param name="input">string</param>
 +        
 +https://demo.clubplanner.be/api/general/UrlDecryptData?token=DEMOTOKEN&input=f8AqhFvuSFv77sbuDOHiBAQIYQ_T6UE77T5CO3uWpjG2DG-pgVweSEG3j_wE_UKCVuDiAnt4KlCH7sZx_P_DpuCxJpOm3gTCucrhl5GNW1Wv25vhFen_ciapW4jJnFY-qCCmD7tmBcfkAo3AtHIidIIL-Vy49V7GF6TqvF2GpiY1
general.1518864465.txt.gz · Last modified: 2018/02/17 12:47 (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