API WIKI

User Tools

Site Tools

Trace: • pos
member

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
member [2021/04/14 15:20]
clubadmin 		member [2026/02/23 11:42] (current)
clubadmin
Line 18: Line 18:
         /// <param name="bic"></param>         /// <param name="bic"></param>
         /// <param name="info1"></param>         /// <param name="info1"></param>
-        /// <param name="info2"></param> +        /// 1..20 
-        /// <param name="info3"></param> +        /// <param name="info20"></param>
-        /// <param name="info4"></param> +
-        /// <param name="info5"></param> +
-        /// <param name="info6"></param> +
-        /// <param name="info7"></param> +
-        /// <param name="info8"></param> +
-        /// <param name="info9"></param> +
-        /// <param name="info10"></param>+
         /// <param name="statusid"></param>         /// <param name="statusid"></param>
-        /// <param name="gender">M or F</param>+        /// <param name="parentmemberid">id of the parent member, leave empty for no link</param> 
 +        /// <param name="gender">M for Male, F for Female, U for unkown, O for others</param>
         /// <param name="note">memo field</param>                /// <param name="note">memo field</param>       
 Example: Example:
Line 59: Line 53:
         /// <param name="bic"></param>         /// <param name="bic"></param>
         /// <param name="info1"></param>         /// <param name="info1"></param>
-        /// <param name="info2"></param> +        /// 1..20 
-        /// <param name="info3"></param> +        /// <param name="info20"></param>
-        /// <param name="info4"></param> +
-        /// <param name="info5"></param> +
-        /// <param name="info6"></param> +
-        /// <param name="info7"></param> +
-        /// <param name="info8"></param> +
-        /// <param name="info9"></param> +
-        /// <param name="info10"></param>+
         /// <param name="statusid">id of the status</param>         /// <param name="statusid">id of the status</param>
 +        /// <param name="parentmemberid">id of the parent member, set to -1 to clear link, leave empty for no changes</param>
         /// <param name="newsletter">0 or 1</param>         /// <param name="newsletter">0 or 1</param>
         /// <param name="from"></param>         /// <param name="from"></param>
Line 90: Line 78:
         /// <param name="email"></param>         /// <param name="email"></param>
  
-Example’s:+Examples:
 https://demo.clubplanner.be/api/member/getmember?token=DEMOTOKEN&id=1 https://demo.clubplanner.be/api/member/getmember?token=DEMOTOKEN&id=1
  
Line 101: Line 89:
 {"Id":1,"UId":"GMOL1","OwnerId":1,"OwnerName":"Demo Brussels","FirstName":"Jane","LastName":"Johanson","CheckInStatus":"20 turns left valid until 7 maart Remainder 60,00 €","CheckInStatusId":"HasRemainderLeft","EmailAddress":"jane.johanson@mail.com","MobileNumber":"04812121340","City":"Bruxelles","Zip":"1000","Address":"Streetroad 1","BirthDate":"14/07/1963","LastVisit":"08/08/2016 17:53","NumberOfVisits":8476,"Password":"0LlHgtVlYrxx3y1ch/lfGFmADSENw1wSK67fxRMQWZjE45FFWta1IrHTIM0oOgr5Q33MbfW7jR7vblHz+uLs","LanguageId":"EN"} {"Id":1,"UId":"GMOL1","OwnerId":1,"OwnerName":"Demo Brussels","FirstName":"Jane","LastName":"Johanson","CheckInStatus":"20 turns left valid until 7 maart Remainder 60,00 €","CheckInStatusId":"HasRemainderLeft","EmailAddress":"jane.johanson@mail.com","MobileNumber":"04812121340","City":"Bruxelles","Zip":"1000","Address":"Streetroad 1","BirthDate":"14/07/1963","LastVisit":"08/08/2016 17:53","NumberOfVisits":8476,"Password":"0LlHgtVlYrxx3y1ch/lfGFmADSENw1wSK67fxRMQWZjE45FFWta1IrHTIM0oOgr5Q33MbfW7jR7vblHz+uLs","LanguageId":"EN"}
  
 +===== Member.DeleteMember =====
 +
 +Method: member/DeleteMember 
 +
 +Deletes a member via MemberId
 +
 +        /// <param name="token"></param>
 +        /// <param name="memberid"></param> 
 +        
 ===== Member.AddSubscription ===== ===== Member.AddSubscription =====
  
Line 110: Line 107:
         /// <param name="token"></param>         /// <param name="token"></param>
         /// <param name="memberid"></param>         /// <param name="memberid"></param>
 +        /// <param name="owner">optional, when not provided it will use home club of member</param>
         /// <param name="subid"></param>         /// <param name="subid"></param>
         /// <param name="startdate"></param>         /// <param name="startdate"></param>
Line 150: Line 148:
         /// <param name="id">the id of the member subscription</param>         /// <param name="id">the id of the member subscription</param>
         /// <param name="amount"></param>         /// <param name="amount"></param>
 +        /// <param name="couponid">optional, id of the coupon, in this case amount can be set to 0, it will automatically use the coupon until empty</param>
         /// <param name="reference">optional, example: id of the webshop transaction</param>         /// <param name="reference">optional, example: id of the webshop transaction</param>
         /// <param name="paymethod">optional, the id of the paymethod</param>         /// <param name="paymethod">optional, the id of the paymethod</param>
Line 173: Line 172:
         /// <param name="option3_amount">optional decimal with the amount of option3</param>         /// <param name="option3_amount">optional decimal with the amount of option3</param>
         /// <param name="removeoptions">optional integer, set to 1 to remove all existing options</param>         /// <param name="removeoptions">optional integer, set to 1 to remove all existing options</param>
 +        /// <param name="note">optional</param>
         /// <param name="from">optional</param>         /// <param name="from">optional</param>
  
Line 210: Line 210:
         /// <param name="todate">mandatory</param>         /// <param name="todate">mandatory</param>
         /// <param name="subscriptionid">optional</param>         /// <param name="subscriptionid">optional</param>
 +        /// <param name="lastmodifiedfrom">optional, extra filter on starting from last modified on date</param>
 +        /// <param name="lastmodifiedto">optional, extra filter on until last modified on date</param>
         /// <param name="owner">optional</param>         /// <param name="owner">optional</param>
                  
Line 251: Line 253:
  
  
-Example's:+Examples:
  
 https://demo.clubplanner.be/api/member/GetSubscriptionOptions?token=DEMOTOKEN&subid=1&ownerid=1 https://demo.clubplanner.be/api/member/GetSubscriptionOptions?token=DEMOTOKEN&subid=1&ownerid=1
Line 276: Line 278:
  
  
 +===== Member.UpdateBlocked=====
  
 +Update blocking of a member.
  
 +        /// <param name="token"></param> 
 +        /// <param name="memberid"></param> 
 +        /// <param name="blocked">0 or 1</param> 
 +        /// <param name="message">optionaly you can provide a text shown to both member and employee</param> 
 +        /// <param name="from"></param>
  
 ===== Member.GetSubscriptions===== ===== Member.GetSubscriptions=====
Line 320: Line 328:
         /// <param name="credit">amount</param>         /// <param name="credit">amount</param>
         /// <param name="id">Member Id</param>         /// <param name="id">Member Id</param>
 +        /// <param name="paymethod">optional, Paymethod Id</param>
         /// <param name="email">Email Address</param>         /// <param name="email">Email Address</param>
         /// <param name="uid">unique card ID</param>         /// <param name="uid">unique card ID</param>
 +        /// <param name="note">optional, note</param>
         /// <param name="from">Example: Icemachine</param>         /// <param name="from">Example: Icemachine</param>
  
Line 419: Line 429:
 Filter on EMAIL (LIKE filter) Filter on EMAIL (LIKE filter)
 https://demo.clubplanner.be/api/Member/GetMembers?token=DEMOTOKEN&filter=email_address%20like%20%27%gmail%%27 https://demo.clubplanner.be/api/Member/GetMembers?token=DEMOTOKEN&filter=email_address%20like%20%27%gmail%%27
 +
 +Filter op LAST MODIFIED (> Filter)
 +https://demo.clubplanner.be/api/Member/GetMembers?token=DEMOTOKEN&filter=last_modified%3E%272022/12/10%27%20
  
 Result: Result:
Line 441: Line 454:
         /// <param name="memberid">ID of member</param>         /// <param name="memberid">ID of member</param>
         /// <param name="message">content of SMS</param>         /// <param name="message">content of SMS</param>
 +        /// <param name="mobilenbr">optional mobile nbr to use</param>
         /// <param name="from"></param>         /// <param name="from"></param>
                  
Line 446: Line 460:
  
 https://demo.clubplanner.be/api/member/SendSMS?token=DEMOTOKEN&memberid=1&message=ABCDEF https://demo.clubplanner.be/api/member/SendSMS?token=DEMOTOKEN&memberid=1&message=ABCDEF
 +
 +https://demo.clubplanner.be/api/member/SendSMS?token=DEMOTOKEN&memberid=1&mobilenbr=123&message=ABCDEF
  
  
Line 482: Line 498:
  
 When password matches it will return HTTP OK, else Badrequest. When password matches it will return HTTP OK, else Badrequest.
 +
 +===== Member.GetContract (GET) =====
 +
 +Get the HTML of the contract for a given member subscription.
 +If no contract has been configured on the subscription type a badrequest is returned.
 +
 +        /// <param name="token"></param>
 +        /// <param name="id">id of membersubscription</param>
 +        /// <param name="from"></param>
 +        
 +Examples:
 +
 +https://demo.clubplanner.be/api/member/GetContract?token=DEMOTOKEN&id=72580
 +
 +Returns:
 +    {
 +        public int subscriptionid
 +        public int memberid
 +        public string contract
 +    }
 +    
 +===== Member.UploadContract (POST) =====
 +
 +Uploads a signed contract (pdf) and stores in the given membersubscription.
 +If no contract has been configured on the subscription type a badrequest is returned.
 +An error is returned when the pdf is empty or the memberid is not the owner of the membersubscription.
 +
 +        /// <param name="token"></param>
 +        /// <param name="id">id of membersubscription</param>
 +        /// <param name="memberid">id of the member</param>
 +        /// <param name="pdf">byte array of the pdf</param>
 +        /// <param name="from"></param>
 +
 +Returns:
 +    {
 +        public int subscriptionid
 +        public int memberid
 +        public int contractid
 +    }
 +    
 +===== Member.ValidateEmailAddress =====
 +
 +Set this email address as a validated email address, this action is logged.
 +Calling updatemember with a new email address will remove the validated timestamp for this field.
 +
 +        /// <param name="token"></param>
 +        /// <param name="memberid">id of the member</param>
 +        /// <param name="email"></param>
 + 
 +returns:
 +    {
 +        public string Message
 +        public bool Failed
 +    }
 +           
 +===== Member.ValidateMobileNumber=====
 +
 +Set the given mobile number as a validated mobile number, this action is logged
 +Calling updatemember with a new email address will remove the validated timestamp for this field.
 +
 +        /// <param name="token"></param>
 +        /// <param name="memberid">id of the member</param>
 +        /// <param name="mobile"></param>
 +        
 + returns:
 +    {
 +        public string Message
 +        public bool Failed
 +    }
 +    
 +===== Member.GetContractState=====
 +
 +Returns all the details of given contract
 +
 +        /// <param name="token"></param>
 +        /// <param name="contractid">id of the contract</param>
 +        
 +===== Member.GetContractFile=====
 +
 +Returns the signed pdf contract of a given contract
 +
 +        /// <param name="token"></param>
 +        /// <param name="contractid">id of the contract</param>
  
member.1618406454.txt.gz · Last modified: 2021/04/14 15:20 by clubadmin

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