users

clients_list

Get users list of club

clients_list

/cp_api?{"method":"clients_list", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	Omschrijving	Geldige waardes
method	string	'clients_list' constant
key	string	Security key
params[memberships]	string	Filter users by status in club	leads, leads_passive, leads_active, valid, not_valid, not_valid_recent, future, old, not_active, active, in_stop, in_medical_stop
params[email]	string	Search user by email, exact match
params[last_update]	time	Updated after requested datetime
params[club_id]	integer	Club id from get_clubs command
params[page]	integer	Page number
params[limit]	integer	Limit of items to return

Out

Naam	Type		Omschrijving
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { club_card_nr: string comment: string zipcode: string address: string inscriptions: hash { index: { inscr_stop_date: date inscr_visitdone: integer inscrtype_name: string inscr_startdate: date inscr_last_visit: date inscr_id: integer inscr_enddate: date inscrtype_id: integer inscr_maxvisit: integer inscrtype_type: integer } } smsLastSent: date valid_member_days: integer brought_by: string email: string sex: string name: string photo: string country: string interjection: string check_in_pincode: string personal_coach: string club_card_amount: string phone: string campaign: string member_number: string smsSent: integer club_card_nr_qrcode: string mob_phone: string province: string sales: string entered: string city: string lastname: string updated_at: date_time labels: string birthday: date } }	Users data hash

get_valid_clients_small

Get users list of club, shorter/faster than clients_list

get_valid_clients_small

/cp_api?{"method":"get_valid_clients_small", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	Omschrijving	Geldige waardes
method	string	'get_valid_clients_small' constant
key	string	Security key
params[page]	integer	Page number
params[per_page]	integer	Limit of items to return
params[memberships]	string	Filter users by status in club	leads, leads_passive, leads_active, valid, not_valid, not_valid_recent, future, old, not_active, active, in_stop, in_medical_stop
params[last_update]	time	Updated after requested datetime
params[club_id]	integer	Club id from get_clubs command
params[access]	string	Put 'access' to get all people who linked to club id
params[starters_from]	date	Date to fetch started members, YYYY-MM-DD
params[starters_until]	date	Date to fetch started members, YYYY-MM-DD
params[stopped_from]	date	Date to fetch stopped members, YYYY-MM-DD
params[stopped_until]	date	Date to fetch stopped members, YYYY-MM-DD

Out

Naam	Type		Omschrijving
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { qr_codes: string glan_card: string club_card: string main_outlet_id: integer barcode_card: string qrcode_card: string email: string sex: string name: string interjection: string rfid_card: date check_in_pincode: string outlet_ids: string member_number: string next_reservation: datetime lastname: string } }	Users data hash

validate_qr

Validate number without check-in

validate_qr

/cp_api?{"method":"validate_qr", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
method	string		'validate_qr' constant
key	string		Security key
params[qr_code]	string	true	QR code read from phone

Out

Naam	Type		Omschrijving

dynamic_qr_check_in

Check in using Dynamic-QR

dynamic_qr_check_in

/cp_api?{"method":"dynamic_qr_check_in", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	Omschrijving
method	string	'dynamic_qr_check_in' constant
key	string	Security key
params[qr]	string	QR code
params[qr_hardware_point_id]	integer	QR hardware point id

Out

Naam	Type	Omschrijving
user_id	integer	User id in case check in are ok, message if not
visit_id	integer	Visit id
revisit	integer	How many times user checked in today

club_card_check_in

Check in using static card number

club_card_check_in

/cp_api?{"method":"club_card_check_in", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	Omschrijving
method	string	'club_card_check_in' constant
key	string	Security key
params[club_card_number]	string	Club card number

Out

Naam	Type	Omschrijving
user_id	integer	User id in case check in are ok, message if not
visit_id	integer	Visit id
revisit	integer	How many times user checked in today

get_valid_clients_vending

Get users list of club, having vending and normal membership

get_valid_clients_vending

/cp_api?{"method":"get_valid_clients_vending", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	Omschrijving
method	string	'get_valid_clients_vending' constant
key	string	Security key
params[page]	integer	Page number
params[limit]	integer	Limit of items to return

Out

Naam	Type		Omschrijving
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { qr_codes: string glan_card: string club_card: string main_outlet_id: integer barcode_card: string qrcode_card: string email: string sex: string name: string interjection: string rfid_card: string check_in_pincode: string outlet_ids: string vending_code: string member_number: string next_reservation: datetime lastname: string } }	Users data hash

client_detail

Get user detail by unique ID

client_detail

/cp_api?{"method":"client_detail", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
method	string		'client_detail' constant
key	string		Security key
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'

Out

Naam	Type	Omschrijving
json_code	integer	Constant value: 14
club_id	integer	Reserved for future, blank now
members_name	string	First name
members_interjection	string	Interjection
members_lastname	string	Last name
members_sex	string	M or F
birthday	date	YYYY-DD-MM format
bank_account	string	Bank account
bank_bic	string	Bank bic
members_address	string	Address
country	string	Country
province	string	Province
members_zipcode	string	Zipcode
members_city	string	City
members_phone	string	Phone
members_mob_phone	string	Mobile phone
members_email	string	Email
personal_coach	string	Personal coach
brought_by	string	Brought by
campaign	string	Campaign
labels	string	Client labels assigned by club, comma separated
entered	string	Entered by
client_photo	string	Url to image (max 100px size)
sales	string	Sales person
club_card_amount	double	Amount stored on club_card
smsSent	integer	sms sent 1 or 0
smsLastSent	date	smsLastSent date, YYYY-MM-DD format

add_money_to_clubcard

Add money to club card

add_money_to_clubcard

/cp_api?{"method":"add_money_to_clubcard", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'add_money_to_clubcard' constant
key	string		Security key
payment_reference	string
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'
params[payment_method_type_id]	integer	true	Payment method type, 1 = Cash, 2 = Bank, 3 = PIN, 10 = Online	1, 2, 3, 10
params[amount]	double	true	Amount to add to user club card'

Out

Naam	Type	Omschrijving
json_code	integer	Constant value: 14
old_club_card_amount	double	Old amount on club card
club_card_amount	double	Current amount on club card

set_card_number

Set new card number to user

set_card_number

/cp_api?{"method":"set_card_number", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'get_client_by' constant
key	string		Security key
params[field]	string	true	One of the values: club_card_nr, club_card_nr_qrcode	club_card_nr, club_card_nr_qrcode
params[value]	string	true	New value of field
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'

Out

Naam	Type		Omschrijving
json_code	integer		Constant value: 14

update_client_info

Update client info by id

update_client_info

/cp_api?{"method":"update_client_info", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'update_client_info' constant
key	string		Security key
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[bank_bic]	string		Bank bic
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email

Out

Naam	Type		Omschrijving
json_code	integer		Constant value: 14

get_client_by

Get user detail by identifier

get_client_by

/cp_api?{"method":"get_client_by", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'get_client_by' constant
key	string		Security key
params[field]	string	true	One of the values: member_number, club_card_nr, club_card_nr_qrcode	member_number, club_card_nr, club_card_nr_qrcode
params[value]	string	true	Value of field

Out

Naam	Type	Omschrijving
json_code	integer	Constant value: 14
client_id	integer	Uniq id of customer
p_persoon	integer	Custom id assigned by School
club_id	integer	Reserved for future, blank now
members_name	string	First name
members_interjection	string	Interjection
club_card_nr_qrcode	string	Club card QR-code
club_card_nr	string	Card number assigned to client
members_lastname	string	Last name
members_sex	string	M or F
birthday	date	YYYY-DD-MM format
bank_account	string	Bank account
bank_bic	string	Bank bic
members_address	string	Address
country	string	Country
province	string	Province
members_zipcode	string	Zipcode
members_city	string	City
members_phone	string	Phone
members_mob_phone	string	Mobile phone
members_email	string	Email
personal_coach	string	Personal coach
brought_by	string	Brought by
campaign	string	Campaign
instelnr	string	Instelnr
school_name	string	School
vestcode	string	Vestcode
vestiging	string	Vestiging
department	string	Afdeling
depcode	string	Afdcode
department_year	string	Afdelingsjaar
class_name	string	Klas
class_number	string	Klasnr
degree	string	Graad
learn_year	integer	Leerjaar
begin_date	date	Begindatum (YYYY-MM-DD)
end_date	date	Einddatum (YYYY-MM-DD)
stop_date	date	Uitgeschreven (YYYY-MM-DD)
labels	string	Client labels assigned by club, comma separated
entered	string	Entered by
client_photo	string	Url to image (max 100px size)
sales	string	Sales person
club_card_amount	double	Amount stored on club_card
smsSent	integer	sms sent 1 or 0
smsLastSent	date	smsLastSent date, YYYY-MM-DD format

req_clientinfo

Get client info

req_clientinfo

/cp_api?{"method":"req_clientinfo", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
method	string		'get_client_by' constant
key	string		Security key
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'

Out

Naam	Type		Omschrijving
json_code	integer		Constant value: 6
member_number	string		Custom id assigned by club
client_name	string		First name
client_interjection	string		Interjection
client_lastname	string		Last name
client_sex	string		M or F
client_birthday	date		YYYY-DD-MM format
client_email	string		Email
client_minutes	double		In development, always return 0.0 now
client_address	string		Client address
client_country	string		Client country
client_province	string		Province
client_client_zipcode	string		Zipcode
client_city	string		City
client_phone	string		Phone
client_mob_phone	string		Mobile
client_club_card_amount	string		Amount left on club card
client_photo	string		Url to image (max 100px size)
personal_coach	string		Personal coach name
brought_by	string		Brought by
campaign	string		Campaign
labels	string		Client labels assigned by club, comma separated
entered	string		Entered by
sales	string		Sales person
smsSent	integer		sms sent 1 or 0
smsLastSent	date		smsLastSent date, YYYY-MM-DD format
client_inscription	hash	{ index: { inscr_stop_date: date inscr_visitdone: integer inscrtype_name: string inscr_startdate: date inscr_last_visit: date inscr_enddate: date inscrtype_id: integer inscr_maxvisit: integer inscrtype_type: integer } }	Client inscription data hash

login

Get user unique ID by login/email and password

login

/cp_api?{"method":"login", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
method	string		'login' constant
key	string		Security key
params[username]	string	true	Login
params[password]	string	true	Password

Out

Naam	Type		Omschrijving
client_id	integer		Unique ID

req_add_new_prospect

Add new prospect

req_add_new_prospect

/cp_api?{"method":"req_add_new_prospect", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email
params[password]	string		Password
params[password]	string		Password confirmation
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[club_card_nr_qrcode]	string		Club card QR-code
params[club_card_nr]	string		Club card code
params[member_number]	integer		Auto generated if blank
params[retention_labels]	array		ID's of labels from 'get_labels' command
params[as_client]	integer		1 to mark user as valid client

Out

Naam	Type	Omschrijving
json_code	integer	Constant value: 29
client_id	integer	Client unique ID
client_number	integer	Client number
username	string	Username
password	string	Password

add_trial

Add new trial/lead

add_trial

/cp_api?{"method":"add_trial", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[name]	integer	true	Lesson id
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[p_persoon]	integer		Auto generated if blank
params[name]	string	true	First name
params[lastname]	string		Last name
params[phone]	string		Phone number
params[mobile_phone]	string		Mobile phone number
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[email]	string		Email
params[start_date]	date		Start date, DD/MM/YYYY format

Out

Naam	Type	Omschrijving
json_code	integer	Constant value: 33
client_id	integer	Client unique ID
reservation_id	integer	Reservation id added by the call
password	string	Password

get_client_fin_info

Get client invoices

get_client_fin_info

/cp_api?{"method":"get_client_fin_info", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'get_client_fin_info' constant
key	string		Security key
params[field]	string	true	One of the values: member_number, club_card_nr, club_card_nr_qrcode	id, member_number, club_card_nr, club_card_nr_qrcode
params[value]	string	true	Value of field

Out

Naam	Type		Omschrijving
invocies	hash	{ index: { pay_url: string price: float pdf_url: string title: string payment_reference: string date: date due_date: date } }	Invocies data hash

add_new_student

Add new student

add_new_student

/cp_api?{"method":"add_new_student", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'add_new_student' constant
key	string		Security key
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[bank_bic]	string		Bank bic
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email
params[password]	string		Password
params[password]	string		Password confirmation
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[club_card_nr_qrcode]	string		Club card QR-code
params[club_card_nr]	string		Club card code
params[p_persoon]	integer		Auto generated if blank
params[instelnr]	string		Instelnr
params[school_name]	string		School
params[vestcode]	string		Vestcode
params[vestiging]	string		Vestiging
params[department]	string		Afdeling
params[depcode]	string		Afdcode
params[department_year]	string		Afdelingsjaar
params[class_name]	string		Klas
params[class_number]	string		Klasnr
params[degree]	string		Graad
params[learn_year]	integer		Leerjaar
params[begin_date]	date		Begindatum (YYYY-MM-DD)
params[end_date]	date		Einddatum (YYYY-MM-DD)
params[retention_labels]	array		ID's of labels from 'get_labels' command
params[as_client]	integer		1 to mark user as valid client

Out

Naam	Type	Omschrijving
json_code	integer	Constant value: 31
client_id	integer	Client unique ID
client_number	integer	Client number
username	string	Username
password	string	Password

update_student_information

Update student information

update_student_information

/cp_api?{"method":"update_student_information", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'update_student_information' constant
key	string		Security key
params[field]	string	true	One of the values: member_number, club_card_nr, club_card_nr_qrcode	member_number, club_card_nr, club_card_nr_qrcode
params[value]	string	true	Value of field
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[bank_bic]	string		Bank bic
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email
params[instelnr]	string		Instelnr
params[vestcode]	string		Vestcode
params[vestiging]	string		Vestiging
params[department]	string		Afdeling
params[depcode]	string		Afdcode
params[department_year]	string		Afdelingsjaar
params[class_name]	string		Klas
params[class_number]	string		Klasnr
params[degree]	string		Graad
params[begin_date]	date		Begindatum (YYYY-MM-DD)
params[end_date]	date		Einddatum (YYYY-MM-DD)
params[stop_date]	date		Uitgeschreven (YYYY-MM-DD)
params[smsSent]	boolean		sms sent	0, 1
params[smsLastSent]	date		smsLastSent date (YYYY-MM-DD)
params[school_name]	string		School
params[learn_year]	integer		Leerjaar
params[retention_labels]	array		ID's of labels from 'get_labels' command

Out

Naam	Type		Omschrijving
json_code	integer		Constant value: 32
client_number	integer		Client number

get_student_sales

Get student sales

get_student_sales

/cp_api?{"method":"get_student_sales", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'get_student_sales' constant
key	string		Security key
params[field]	string	true	One of the values: member_number, club_card_nr, club_card_nr_qrcode	member_number, club_card_nr, club_card_nr_qrcode
params[value]	string	true	Value of field

Out

Naam	Type		Omschrijving
products	hash	{ index: { price: double title: string code: string payment_reference: string date: date } }	Products data hash

get_student_information_query

Get students list by filter

get_student_information_query

/cp_api?{"method":"get_student_information_query", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	Omschrijving
method	string	'get_student_information_query' constant
key	string	Security key
params[instelnr]	string	Filter students by Instelnr
params[school_name]	string	Filter students by School
params[vestcode]	string	Filter students by Vestcode
params[vestiging]	string	Filter students by Vestiging
params[department]	string	Filter students by Afdeling
params[depcode]	string	Filter students by Afdcode
params[department_year]	string	Filter students by Afdelingsjaar
params[class_name]	string	Filter students by Klas
params[class_number]	string	Filter students by Klasnr
params[degree]	string	Filter students by Graad
params[learn_year]	integer	Filter students by Leerjaar
params[begin_date]	date	Filter students by Begindatum (YYYY-MM-DD)
params[end_date]	date	Filter students by Einddatum (YYYY-MM-DD)
params[stop_date]	date	Filter students by Uitgeschreven (YYYY-MM-DD)
params[page]	integer	Page number
params[limit]	integer	Limit of items to return

Out

Naam	Type	Omschrijving
p_persoon	string	Custom id assigned by School
club_card_nr_qrcode	string	Club card QR-code
club_card_nr	string	Card number assigned to client
student_id	integer	Uniq id of student
student_name	string	First name
student_interjection	string	Interjection
student_lastname	string	Last name
student_gender	string	M or F
birthday	date	YYYY-DD-MM format
bank_account	string	Bank account
bank_bic	string	Bank bic
student_address	string	Address
country	string	Country
student_zipcode	string	Zipcode
student_city	string	City
student_phone	string	Phone
student_mob_phone	string	Mobile phone
student_email	string	Email
personal_coach	string	Personal coach
brought_by	string	Brought by
campaign	string	Campaign
instelnr	string	Instelnr
school_name	string	School
vestcode	string	Vestcode
vestiging	string	Vestiging
department	string	Afdeling
depcode	string	Afdcode
department_year	string	Afdelingsjaar
class_name	string	Klas
class_number	string	Klasnr
degree	string	Graad
learn_year	integer	Leerjaar
begin_date	date	Begindatum (YYYY-MM-DD)
end_date	date	Einddatum (YYYY-MM-DD)
stop_date	date	Uitgeschreven (YYYY-MM-DD)
labels	string	Client labels assigned by club, comma separated
entered	string	Entered by
client_photo	string	Url to image (max 100px size)
sales	string	Sales person
club_card_amount	double	Amount stored on club_card
current_page	integer	Page number that was requested
total_pages	integer	Total number of pages for request
users	hash	Users data hash

custom_blocks

Get list of custom blocks and fields

custom_blocks

/cp_api?{"method":"custom_blocks", "key":"xxxxxxxx", "params":{......} }

Out

Naam	Type		Omschrijving
blocks	hash	{ index: { title: string id: integer fields: hash { index: { is_required: boolean Title: string type_id: integer id: integer values: string } } } }	Blocks

custom_blocks_submit

Submit new data to grid style blocks

custom_blocks_submit

/cp_api?{"method":"custom_blocks_submit", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
params[user_id]	integer	true	User ID from clients_list
params[block_id]	integer	true	Block ID from custom_blocks command
params[fields]	hash	true	Hash of values, key is ID of field from custom_blocks, value is actual value to store

Out

Naam	Type		Omschrijving
saved	integer		Count of saved records

custom_blocks_values

Read data of blocks of user

custom_blocks_values

/cp_api?{"method":"custom_blocks_values", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[user_id]	integer	true	User ID from clients_list
params[block_id]	integer	true	Block ID from custom_blocks command

Out

Naam	Type		Omschrijving
data	hash	{ index: { index: string } }	Data

Naam	Type		Omschrijving
invoices	hash	{ index: { payments: hash { index: { payment_method: string amount: double at: datetime } } paid: double price: double pdf_url: string type_id: integer code: string payment_reference: string date: date due_date: date } }	Invoices data hash

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'get_payments' constant
key	string		Security key
params[payment_method_type_id]	integer	true	Payment method type, 1 = Cash, 2 = Bank, 3 = PIN, 10 = Online	1, 2, 3, 10
data_from	string		Start data('yyyy-mm-dd') of period
data_to	string		End data('yyyy-mm-dd') of period
by_terminal	string		Select payment payd by terminal. Only for PIN.

Naam	Type		Omschrijving
payments	hash		Payments data hash

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'get_payments' constant
key	string		Security key
params[payment_method_type_id]	integer	true	Payment method type, 1 = Cash, 2 = Bank, 3 = PIN, 10 = Online	1, 2, 3, 10
data_from	string		Start data('yyyy-mm-dd') of period
data_to	string		End data('yyyy-mm-dd') of period
by_terminal	string		Select payment payd by terminal. Only for PIN.

reservations

req_activity_groups

Get activity group types

req_activity_groups

/cp_api?{"method":"req_activity_groups", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string		'req_activity_groups' constant
key	string		Security key

Out

Naam	Type		Omschrijving
groups	hash	{ index: { event: string group_name: string group_id: string } }	Group types data hash

req_activity_group_details

Get activity group details

req_activity_group_details

/cp_api?{"method":"req_activity_group_details", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	Omschrijving
method	string	'req_activity_group_details' constant
key	string	Security key
params[date]	date	Date
params[group_id]	integer	Activity group type ID
params[club_id]	integer	Outlet id from get_clubs command

Out

Naam	Type		Omschrijving
json_code	integer		Constant value: 2
activities	hash	{ index: { description: string ext_description: string end_time: time schedule: hash { index: { id: integer waitlist_size: integer start: time available: integer } } staff_name: string staff_id: integer activity_id: integer start_time: time capacity: integer activity_id_name: string } }	Activities data hash

req_reservation

Get reservation

req_reservation

/cp_api?{"method":"req_reservation", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
params[count]	integer		Сount reservations
params[client_id]	integer	true	Client ID
params[date_time]	date	true	Date time, dd/mm/yyyy HH:MM:SS
params[activity_id]	integer	true	Activity ID

Out

Naam	Type		Omschrijving
json_code	integer		Constant value: 4

req_cancel

Сancel reservation

req_cancel

/cp_api?{"method":"req_cancel", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
params[count]	integer		Сount reservations
params[client_id]	integer	true	Client ID
params[date_time]	date	true	Date
params[activity_id]	integer	true	Activity ID

Out

Naam	Type		Omschrijving
json_code	integer		Constant value: 4

req_current_reservations

Get current reservation

req_current_reservations

/cp_api?{"method":"req_current_reservations", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
params[client_id]	integer	true	Client ID
params[start_date]	date	true	Start date
params[end_date]	date	true	End date

Out

Naam	Type		Omschrijving
activities	hash	{ index: { status: string price: string count: string activity_id: integer start: time date: date activity_id_name: string } }	Activities data hash

req_addtowaitlist

Add to waitlist

req_addtowaitlist

/cp_api?{"method":"req_addtowaitlist", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving
params[client_id]	integer	true	Client ID
params[date_time]	date	true	Date
params[activity_id]	integer	true	Activity ID

Out

Naam	Type		Omschrijving
json_code	integer		Constant value: 37

get_reservations

Get reservations

get_reservations

/cp_api?{"method":"get_reservations", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[date_time]	date	true	Date time, dd/mm/yyyy HH:MM:SS
params[activity_id]	integer	true	Activity ID

Out

Naam	Type		Omschrijving
reservations	hash	{ index: { id: integer user_id: integer } }	Reservations data hash

get_waitlist

Get waitlist

get_waitlist

/cp_api?{"method":"get_waitlist", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[date_time]	date	true	Date time, dd/mm/yyyy HH:MM:SS
params[activity_id]	integer	true	Activity ID

Out

Naam	Type		Omschrijving
waitlist	hash	{ index: { user_name: string id: integer user_id: integer } }	waitlist data hash
activity_title	string		Activity title

reserve_from_waitlist

Move user from waitlist to reservation

reserve_from_waitlist

/cp_api?{"method":"reserve_from_waitlist", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[waitlist_id]	integer	true	Waitlist ID from 'get_waitlist'

Out

Naam	Type		Omschrijving
status	boolean		Is operation done
message	string		Text explanation of error/success result

req_act_shedule

Return shedule of activities

req_act_shedule

/cp_api?{"method":"req_act_shedule", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	Omschrijving
params[sub_type_id]	integer	0 - Activity, 1 - Event, 2 - Workshop
params[staff_id]	integer	ID of staff from 'clients_list'
params[club_id]	integer	Club ID of staff from 'get_clubs'

Out

Naam	Type		Omschrijving
shedule	hash	{ index: { startdate: date enddate: date staff_id: integer activity_id: integer with_membership_price: double shedule: hash { index: { start: time weekday: integer } } sub_type_id: integer no_membership_price: double club_id: integer group_id: integer is_active: boolean activity_id_name: string } }	Shedule

get_holidays

Get holidays

get_holidays

/cp_api?{"method":"get_holidays", "key":"xxxxxxxx", "params":{......} }

Out

Naam	Type		Omschrijving
holidays	hash		Holidays

Naam	Type	verplicht	Omschrijving
method	string		'buy_product_from_club_card' constant
key	string		Security key
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'
params[product_id]	integer	true	Product database ID
params[quantity]	integer	true	Quantity of products to sell
params[amount]	double	true	Total amount in format 123.45

Naam	Type	Omschrijving
method	string	'products' constant
key	string	Security key
params[page]	integer	Page number
params[limit]	integer	Limit of items to return

Naam	Type	Omschrijving
method	string	'inscrtypes_list_online' constant
key	string	Security key
params[club_id]	integer	Club ID of staff from 'get_clubs'

Naam	Type	verplicht	Omschrijving
method	string		'inscrtype_activities' constant
key	string		Security key
params[inscription_id]	integer	true	Unique ID of inscription period

Naam	Type	Omschrijving
json_code	integer	Constant value: 30
client_id	integer	Unique ID of user
inscription_id	integer	Unique ID of inscription period
to_pay	double	Invoice unpaid amount
total	double	Total price

Naam	Type	Omschrijving	Geldige waardes
method	string	'get_staffs' constant
key	string	Security key
params[club_id]	integer	Club id from get_clubs command
params[access]	string	Put 'access' to get all people who linked to club id	access, admin
params[page]	integer	Page number
params[limit]	integer	Limit of items to return

Naam	Type	verplicht	Omschrijving
params[visits]	array	true	Array of hash values, in hash - keys are 'user_id' or 'member_number' and 'at', where at is time field in YYYY-MM-DD HH:MM:SS format
params[user_id]	string		User id
params[member_number]	integer		Member number
params[qr_code]	string		If special QR-codes option is ON
params[member_number]	integer		Member number

Naam	Type	Omschrijving
params[club_id]	integer	Club id, not implemented, now all mailings/sms groups is global
params[SMSGroups]	boolean	Sms group, 0 - get mailing groups, 1 - get sms groups
params[group]	integer	Group id, return all or specific group by id
params[suppress_details]	boolean	Suppress details, 0 - get users in groups, 1 - only name and id of groups returned

Naam	Type	Omschrijving
method	string	'get_inscription_invoice_date' constant
key	string	Security key
params[inscription_id]	integer	Inscription ID
params[date]	date	Inscription start date, YYYY-DD-MM format

Naam	Type	Omschrijving
total	float	Total price to be paid by client
pro_rata	float	Price per period, discount is applied for this
start_fee	float	Membership start fee
period_price	float	Total pro rata price to be paid by client for all period

Naam	Type	Omschrijving
json_code	integer	Constant value 30
client_id	integer	Client internal id
inscription_id	integer	Inscription ID that was sold
payment_reference_one	string	Invoice reference number for first period
period_one	float	Total price for first period
payment_reference_two	string	Invoice reference number for next period, blank if no next period
period_two	float	Total price for first period, blank if no next period

Hoe het werkt

users

clients_list

clients_list

In

Out

get_valid_clients_small

get_valid_clients_small

In

Out

validate_qr

validate_qr

In

Out

dynamic_qr_check_in

dynamic_qr_check_in

In

Out

club_card_check_in

club_card_check_in

In

Out

get_valid_clients_vending

get_valid_clients_vending

In

Out

client_detail

client_detail

In

Out

add_money_to_clubcard

add_money_to_clubcard

In

Out

set_card_number

set_card_number

In

Out

update_client_info

update_client_info

In

Out

get_client_by

get_client_by

In

Out

req_clientinfo

req_clientinfo

In

Out

login

login

In

Out

req_add_new_prospect

req_add_new_prospect

In

Out

add_trial

add_trial

In

Out

get_client_fin_info

get_client_fin_info

In

Out

add_new_student

add_new_student

In

Out

update_student_information

update_student_information

In

Out

get_student_sales

get_student_sales

In

Out

get_student_information_query

get_student_information_query