Gebruikershulpmiddelen

Site-hulpmiddelen


configuratie

1. Authentication

Every message that is sent to Club Planner API must be accompanied by a token that is preconfigured in the club planner database parameters.

2 Functions

2.1 Member.Connect

Can be used to make your own custom login box on your website. This will not store the ID/pwd in a cookie.

Example: https://cloud.clubplanner.be/demo/api/member/Connect?id=1&pwd=xyz

Will return 200 OK or 400 Bad Request when failed.

When you get an OK, you can afterwards got the base URL and member will be logged in already.

2.2 Member.AddMember

Method: member/AddMember

      /// <summary>
      /// Adds a new member without a subscription
      /// </summary>
      /// <param name="token"></param>
      /// <param name="firstname"></param>
      /// <param name="lastname"></param>
      /// <param name="addressline"></param>
      /// <param name="city"></param>
      /// <param name="zip"></param>
      /// <param name="email"></param>
      /// <param name="mobile"></param>
      /// <param name="dayofbirth"></param>
      /// <param name="owner"></param>
      /// <param name="iban"></param>
      /// <param name="bic"></param>
      /// <param name="info1"></param>
      /// <param name="info2"></param>
      /// <param name="info3"></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>

Example: https://cloud.clubplanner.be/demo/api/member/addmember?token=DEMOTOKEN&firstname=John&lastname=Peterson

Result:

{“Id”:123456817,“OwnerId”:1,“OwnerName”:“Demo”,“FullName”:“John Peterson”,“CheckInStatus”:“No valid subscription found”}

2.3 Member.UpdateMember

Method: member/UpdateMember

      /// <summary>
      /// Updates an existing member
      /// </summary>
      /// <param name="token"></param>
      /// <param name="memberid"></param>
      /// <param name="firstname"></param>
      /// <param name="lastname"></param>
      /// <param name="addressline"></param>
      /// <param name="city"></param>
      /// <param name="zip"></param>
      /// <param name="email"></param>
      /// <param name="mobile"></param>
      /// <param name="dayofbirth"></param>
      /// <param name="owner"></param>
      /// <param name="iban"></param>
      /// <param name="bic"></param>
      /// <param name="info1"></param>
      /// <param name="info2"></param>
      /// <param name="info3"></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=“from”></param> ===== 2.4 General.GetClubs ===== Method: general/GetClubs / <summary>

      /// Returns all clubs available
      /// </summary>
      /// <param name="token"></param>

Example:

https://cloud.clubplanner.be/demo/api/general/GetClubs?token=DEMOTOKEN

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”}]

2.5 Member.GetMember

Method: member/GetMember

      /// <summary>
      /// Get a member via MemberId, put in the ID OR email
      /// </summary>
      /// <param name="token"></param>
      /// <param name="id"></param> 
      /// <param name="email"></param>

Example’s: https://cloud.clubplanner.be/demo/api/member/getmember?token=DEMOTOKEN&id=1

or

https://cloud.clubplanner.be/demo/api/member/getmember?token=DEMOTOKEN&email=jane.johanson%40mail.com

Result:

{“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”}

2.6 Member.AddSubscription Method: member/AddSubscription

      /// <param name="token"></param>
      /// <param name="memberid"></param>
      /// <param name="subid"></param>
      /// <param name="startdate"></param>
      /// <param name="option1"></param>
      /// <param name="option2"></param>
      /// <param name="option3"></param>
  /// <param name="reference"></param>
  /// <param name="from"></param>

Add a subscription to a given member.

Note : you can’t have 2 subscriptions active on the same date, in that case the API will return a 400 badrequest.

Examples: https://cloud.clubplanner.be/demo/api/member/AddSubscription?token=DEMOTOKEN&memberid=1&subid=1&startdate=01/01/2018&reference=mollie_tx_1234534789

https://cloud.clubplanner.be/demo/api/member/AddSubscription?token=DEMOTOKEN&memberid=1&subid=2&startdate=01/01/2017&option1=1

https://cloud.clubplanner.be/demo/api/member/AddSubscription?token=DEMOTOKEN&memberid=2&subid=2&startdate=20/12/2017&option1=1&option2=2&option3=3&reference=mollie_tx_1234534789

2.7 Member.GetMemberSubscriptions / <param name=“token”></param> / <param name=“memberid”></param>

Get the list of membersubscriptions for a given member. Note : only items with begindate < today + 30 days will be returned.

Example : https://cloud.clubplanner.be/demo/api/member/GetMemberSubscription?token=DEMOTOKEN&memberid=1

2.8 Member.ForgotPassword

      /// <param name="token"></param>
      /// <param name="memberid"></param>
      /// <param name="email"></param>

Sends an email to the member with the memberid and password. This email can be configured using an email template. You need to provide memberid or email. Can be used in a forgot password screen on a website .

Return Ok when password was sent, or BadRequest when member was not found.

2.9 Member.GetSubscriptionOptions Method: member/GetSubscriptionOptions

      /// <param name="token"></param>
      /// <param name="subid"></param>
  /// <param name="ownerid"></param>

Get the options for a given subscription.

Example : https://cloud.clubplanner.be/demo/api/member/GetSubscriptionOptions?token=DEMOTOKEN&subid=1&ownerid=1

https://cloud.clubplanner.be/demo/api/member/GetSubscriptionOptions?token=DEMOTOKEN&subid=2&ownerid=1

2.10 General.GetClub Method: general/GetClub

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

Get the properties of a given club

Example: https://cloud.clubplanner.be/demo/api/general/GetClub?token=DEMOTOKEN&id=1

2.11 General.GetCheckInPoint

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

Get the properties of a given checkinpoint

Example: https://cloud.clubplanner.be/demo/api/general/GetClub?token=DEMOTOKEN&id=1

2.12 Member.GetStatusses

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

Get all configured statustypes.

2.13 Member.UpdateStatus

      /// <param name="token"></param>
      /// <param name="memberid"></param>
      /// <param name="statusid"></param>
      /// <param name="from"></param>

Update the status of a member.

2.14 Member.UpdateSubscription

      /// <param name="token"></param>
      /// <param name="id"></param>
      /// <param name="startdate"></param>
      /// <param name="reference"></param>
      /// <param name="enddate"></param>
  /// <param name="from"></param>

Update a given membersubscription.

2.15 Member.DeleteSubscription

      /// <param name="token"></param>
      /// <param name="id"></param>
  /// <param name="from"></param>

Removes a given membersubscription.

Note : you can only delete unpaid membersubscriptions via the API.

2.16 Member.GetSubscriptions

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

Get the configured subscriptiontypes of a given club

2.17 Planner.GetCalendars http://cloud.clubplanner.be/demo/api/planner/getcalendars?token=DEMOTOKEN&memberid=1

      /// <summary>
      /// Returns all calendargroups available
      /// </summary>
      /// <param name="token"></param>
      /// <param name="memberid"></param>

2.18 Planner.GetCalendarItems http://cloud.clubplanner.be/demo/api/planner/getcalendarItems?token=DEMOTOKEN&id=1&date=01/01/2017&days=7

      /// <summary>
      /// Returns all items in the give calendar where the member has access to
      /// </summary>
      /// <param name="token"></param>
      /// <param name="id"></param>
      /// <param name="date"></param>
      /// <param name="days">1</param>

Get all calenderitems for a given calender and date, set id = 0 for all calendars (= no filter).

2.19 Planner.AddReservation

      /// <param name="token"></param>
      /// <param name="memberid"></param>
      /// <param name="itemid"></param>
      /// <param name="quantity"></param>
      /// <param name="logtype"></param>
      /// <param name="from"></param>

Add a reservation to a calendaritem

2.20 Planner.GetReservations

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

Get all the reservations for a given member

2.21 Planner.CancelReservation

      /// <param name="token"></param>
      /// <param name="reservationid"></param>
      /// <param name="from"></param>

Cancel a given reservation

configuratie.txt · Laatst gewijzigd: 2017/11/10 17:36 door kristof