CAPI - Self Training Booking

This document guides the developer on how to use CAPI services to book a Self Training session. ​ The reader is advised to familiarise himself/herself with the Self Training> Booking process by reading CReME - Self Training Booking before this. The user is also assumed to be familiar with CAPI - Introduction.

Displaying the webpage requires:

• populating the Location dropdown list with the list of locations
• populating the panel below with the session icons

To populate the Dropdown List, the following request is submitted: ​

• Request URI: [CAPI base address] + capi/ReadMatrix
• Body: ChannelKey:CEV75FGS6TA2VMYHF6G9MKV7;MatrixName:SelfTrainingLocations (there is no ";" at the end of the request)
• List Value Column: ClassLocationId (please do not use "Id" as this has been retired)
• List Text Column: TitleClubCode
• Response:

To populate the panel of session icons, the following request is submitted: ​

• Request URI: [CAPI base address] + v1/SelfTraining/Events/7DaysFromNow
• Body: ChannelKey:CEV75FGS6TA2VMYHF6G9MKV7;SessionKey:38J4VVNR8TE8VP757RJY3LGM;eMailAddress:lyndon.olive@gmail.com;ClassLocationId:1588811 (there are no spaces in this string)
  (the SessionKey show here is for illustration purposes only. You will need to generate your own SessionKey)
  (the SessionKey and eMailAddress are that of the user currently logged in to CReME™)
  (the ClassLocationId is obtained from the Location dropdown list)
  (there is no ";" at the end of the request)
• Response:

Every response contains:

• One and only one header
• Multiple number of Days
• Multiple Sessions per day.

Every response header contains 3 parameters. These appear only once in each response and have been explained in CReME - Self Training Booking

• DurationInMinutes
• BookingOpensInHoursBeforeStart
• Capacity

The number of Days varies depending on the length of BookingOpensInHoursBeforeStart. It will be the next highest integer of days after interval expires. For example, if BookingOpensInHoursBeforeStart=72 hours (3days), the next highest integer is 4. If BookingOpensInHoursBeforeStart=36 hours (1.5days), the number of Days returned will be 2. Please confirm with the customer the minimum and maximum expected values for BookingOpensInHoursBeforeStart so your code will be able to display the panel properly.

The attributes beginning with "StartOf" (StartOfFirstSessionHour etc) are not used and so will not be discussed here.

NoSessionScheduled is a boolean. False indicates there will be no Sessions for that day. True indicates there will be at least one Session during that day.

Tarikh (the Malaysian word for "date") will appear in yyyy-MM-ddTHH:mm:ss format but only the yyyy, MM and dd values will be used. The HH, mm and ss values for Daywill always be zero.

The number of Sessions per day can vary. This has been explained above under NoSessionsSechduled

ClassLocationId is the same ClassLocationId in the request. It is the same for all Sessions.

StartTime is when the Session is scheduled to begin. It will appear in yyyy-MM-ddTHH:mm:ss format. All values (yyyy, MM, dd, HH, mm and ss) will be used.

An explanation of possible values for SessionStatus can be found in CReME - Self Training Booking

SessionIdentifier is unique for each Session. This will be used later when booking a Session

After a user clicks on an available icon, the icon changes to click to confirm. Clicking Confirm sends the following request to CAPI:

• Request URI: [CAPI base address] + v1/SelfTraining/ClassInstancePerson/Create
• Body: ChannelKey:CEV75FGS6TA2VMYHF6G9MKV7;SessionKey:6986ZKRZF7HRTPW4BJ99CQLG;eMailAddress:lyndon.olive@gmail.com;SelfTrainingSessionIdentifier:1588811_202007041700 (there are no spaces in this string)
  (the SessionKey show here is for illustration purposes only. You will need to generate your own SessionKey)
  (the SessionKey and eMailAddress are that of the user currently logged in to CReME™)
  (there is no ";" at the end of the request)
• Response:

If the booking is successful, the user receives a confirmation by email. This has been described in CReME - Self Training Booking.

For a list of StatusMessages, please refer to the StatusMessage page in CReME™. The relevant StatusMessages can be found under Entity.Action of ClassInstancePerson.CreateST.