Naam | Type | verplicht | 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 |
Naam | Type | Omschrijving | |
---|---|---|---|
current_page | integer | Page number that was requested | |
total_pages | integer | Total number of pages for request | |
users | hash |
{
id: { }sales: string }email: string smsSent: integer campaign: string country: string labels: string personal_coach: string address: string club_card_nr: string photo: string phone: string comment: string brought_by: string city: string club_card_amount: string sex: string valid_member_days: integer check_in_pincode: string updated_at: date_time lastname: string smsLastSent: date club_card_nr_qrcode: string zipcode: string province: string birthday: date member_number: string inscriptions: hash { entered: stringindex: { }inscr_maxvisit: integer }inscrtype_type: integer inscr_id: integer inscr_last_visit: date inscr_enddate: date inscr_visitdone: integer inscrtype_id: integer inscrtype_name: string inscr_startdate: date inscr_stop_date: date name: string mob_phone: string interjection: string |
Users data hash |
Naam | Type | verplicht | 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 |
Naam | Type | Omschrijving | |
---|---|---|---|
current_page | integer | Page number that was requested | |
total_pages | integer | Total number of pages for request | |
users | hash |
{
id: { }email: string }rfid_card: date glan_card: string barcode_card: string main_outlet_id: integer sex: string qr_codes: string check_in_pincode: string lastname: string next_reservation: datetime qrcode_card: string member_number: string club_card: string name: string outlet_ids: string interjection: string |
Users data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'validate_qr' constant | ||
key | string | Security key | ||
params[qr_code] | string | true | QR code read from phone |
Naam | Type | Omschrijving |
---|
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 | ||
params[staff_id] | string | Staff that will check in, used to determine outlet |
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 | |
check_out | date | When check out was registered |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'club_card_check_in' constant | ||
key | string | Security key | ||
params[club_card_number] | string | Club card number | ||
params[staff_id] | string | Staff that will check in, used to determine outlet |
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 |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'get_valid_clients_vending' constant | ||
key | string | Security key | ||
params[page] | integer | Page number | ||
params[limit] | integer | Limit of items to return |
Naam | Type | Omschrijving | |
---|---|---|---|
current_page | integer | Page number that was requested | |
total_pages | integer | Total number of pages for request | |
users | hash |
{
id: { }email: string }rfid_card: string glan_card: string barcode_card: string main_outlet_id: integer sex: string qr_codes: string check_in_pincode: string lastname: string next_reservation: datetime qrcode_card: string member_number: string club_card: string name: string vending_code: string outlet_ids: string interjection: string |
Users data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'client_detail' constant | ||
key | string | Security key | ||
params[client_id] | integer | true | User database ID, not 'Custom ID assigned by club' |
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 | ||
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 |
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' |
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 |
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' |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 14 |
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 14 |
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 |
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 | ||
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 |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'get_client_by' constant | ||
key | string | Security key | ||
params[client_id] | integer | true | User database ID, not 'Custom ID assigned by club' |
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 | ||
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_maxvisit: integer }inscrtype_type: integer inscr_last_visit: date inscr_enddate: date inscr_visitdone: integer inscrtype_id: integer inscrtype_name: string inscr_startdate: date inscr_stop_date: date |
Client inscription data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'login' constant | ||
key | string | Security key | ||
params[username] | string | true | Login | |
params[password] | string | true | Password |
Naam | Type | Omschrijving | |
---|---|---|---|
client_id | integer | Unique ID |
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 | |||
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 |
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 |
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 | |||
params[start_date] | date | Start date, DD/MM/YYYY format |
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 |
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
invocies | hash |
{
index: { }title: string }due_date: date payment_reference: string pay_url: string date: date pdf_url: string price: float |
Invocies data hash |
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 | |||
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 |
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 |
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 | |||
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 32 | |
client_number | integer | Client number |
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
products | hash |
{
index: { }title: string }payment_reference: string date: date price: double code: string |
Products data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 |
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 | ||
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
blocks | hash |
{
index: { }title: string }id: integer fields: hash { index: { }is_required: boolean }Title: string id: integer type_id: integer values: string |
Blocks |
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 | |
params[fields] | hash | true | Hash of values, key is ID of field from custom_blocks, value is actual value to store |
Naam | Type | Omschrijving | |
---|---|---|---|
saved | integer | Count of saved records |
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
data | hash |
{
index: { }index: string } |
Data |
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
invoices | hash |
{
index: { }due_date: date }payment_reference: string date: date pdf_url: string type_id: integer price: double payments: hash { paid: doubleindex: { }amount: double }payment_method: string at: datetime code: string |
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. |
Naam | Type | Omschrijving | |
---|---|---|---|
payments | hash | Payments data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 | |
---|---|---|---|
json_code | integer | Constant value: 6 | |
old_club_card_amount | double | Amount on club card before sale | |
club_card_amount | double | Amount on club card after sale |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'get_products' constant | ||
key | string | Security key |
Naam | Type | Omschrijving | |
---|---|---|---|
products | hash |
{
index: { }destroyed: boolean }title: string vatpercent: double priceexclvat: double priceinclvat: double category_id: integer articleno: string prod_id: integer descr: string |
Products data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'get_labels' constant | ||
key | string | Security key |
Naam | Type | Omschrijving | |
---|---|---|---|
categories | hash |
{
index: { }title: string }label_id: integer |
Categories data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'products' constant | ||
key | string | Security key | ||
params[page] | integer | Page number | ||
params[limit] | integer | Limit of items to return |
Naam | Type | Omschrijving | |
---|---|---|---|
current_page | integer | Page number that was requested | |
total_pages | integer | Total number of pages for request | |
products | hash |
{
id: { }vat: double }title: string pos_ids: array price: double outlet_ids: array |
Products data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'get_labels' constant | ||
key | string | Security key |
Naam | Type | Omschrijving | |
---|---|---|---|
labels | hash |
{
index: { }allowed_minus: double }title: string label_id: integer max_per_day: double |
Labels data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'req_activity_groups' constant | ||
key | string | Security key |
Naam | Type | Omschrijving | |
---|---|---|---|
groups | hash |
{
index: { }event: string }group_id: string group_name: string |
Group types data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 2 | |
activities | hash |
{
index: { }staff_id: integer }activity_id: integer end_time: time ext_description: string staff_name: string schedule: hash { start_time: timeindex: { }id: integer }waitlist_size: integer available: integer start: time description: string activity_id_name: string capacity: integer |
Activities data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 4 |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 4 |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
params[client_id] | integer | true | Client ID | |
params[start_date] | date | true | Start date | |
params[end_date] | date | true | End date |
Naam | Type | Omschrijving | |
---|---|---|---|
activities | hash |
{
index: { }status: string }count: string activity_id: integer date: date price: string activity_id_name: string start: time |
Activities data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
params[client_id] | integer | true | Client ID | |
params[date_time] | date | true | Date | |
params[activity_id] | integer | true | Activity ID |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 37 |
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
reservations | hash |
{
index: { }id: integer }user_id: integer |
Reservations data hash |
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 |
Naam | Type | Omschrijving | |
---|---|---|---|
waitlist | hash |
{
index: { }id: integer }user_id: integer user_name: string |
waitlist data hash |
activity_title | string | Activity title |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
params[waitlist_id] | integer | true | Waitlist ID from 'get_waitlist' |
Naam | Type | Omschrijving | |
---|---|---|---|
status | boolean | Is operation done | |
message | string | Text explanation of error/success result |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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' |
Naam | Type | Omschrijving | |
---|---|---|---|
shedule | hash |
{
index: { }staff_id: integer }club_id: integer group_id: integer is_active: boolean sub_type_id: integer activity_id: integer no_membership_price: double startdate: date shedule: hash { enddate: dateindex: { }start: time }weekday: integer activity_id_name: string with_membership_price: double |
Shedule |
Naam | Type | Omschrijving | |
---|---|---|---|
holidays | hash | Holidays |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
params[client_id] | integer | true | Client ID | |
params[start_date] | date | true | Start date | |
params[weeks] | string | true | Weeks of stopperiod |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 25 |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
params[client_id] | integer | true | Client ID |
Naam | Type | Omschrijving | |
---|---|---|---|
stopperiods | hash |
{
index: { }end_date: date }reason: string start_date: date |
Stopperiods data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
params[client_id] | integer | true | Client ID | |
params[start_date] | date | true | Start date YYYY-MM-DD format |
Naam | Type | Omschrijving | |
---|---|---|---|
json_code | integer | Constant value: 37 |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'inscrtypes_list_online' constant | ||
key | string | Security key | ||
params[club_id] | integer | Club ID of staff from 'get_clubs' |
Naam | Type | Omschrijving | |
---|---|---|---|
inscrtypes | hash |
{
index: { }id: integer }type: integer price_start_two: hash price_two: hash online_discount_description: string have_custom_link_of_activities: boolean price_start_one: hash price_one: hash free_period_membership_id: integer auto_renew: boolean price: double start_from_first_of_month: boolean description: string period_title: string name: string payment_period_title: string |
Memberships data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'inscrtype_activities' constant | ||
key | string | Security key | ||
params[inscription_id] | integer | true | Unique ID of inscription period |
Naam | Type | Omschrijving | |
---|---|---|---|
inscrtype_activities | hash |
{
index: { }online_discount_description: string }free_period_membership_id: integer description: string |
Activities data hash |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
params[client_id] | integer | true | Client ID | |
params[inscription_id] | integer | true | Unique ID of inscription period | |
params[start_date] | date | true | Start date YYYY-MM-DD format | |
params[discount_percent] | double | Discount percent - leading | ||
params[discount_money] | double | Discount money | ||
params[prepaid_amount] | double | Prepaid amount | ||
params[payment_method] | integer | Payment method, where 1 = Cash, 2 = Bank, 5 = SEPA, 10 = Online | 1, 2, 5, 10 |
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 | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'get_clubs' constant | ||
key | string | Security key |
Naam | Type | Omschrijving | |
---|---|---|---|
clubs | hash |
{
id: { }title: string } |
Outlets, id and title |
Naam | Type | verplicht | 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 | Omschrijving | |
---|---|---|---|
current_page | integer | Page number that was requested | |
total_pages | integer | Total number of pages for request | |
staffs | hash |
{
id: { }email: string }title: string id: integer rfid_card: string glan_card: string photo: string barcode_card: string sex: string lastname: string qrcode_card: string member_number: string club_card: string interjection: string |
Staffs, id and title |
Naam | Type | Omschrijving | |
---|---|---|---|
clubs | hash |
{
id: { }title: string }id: integer poses: hash { id: { }title: string }id: integer |
Outlets info |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
params[date] | date | true | Date YYYY-MM-DD format | |
params[club_id] | integer | true | Club ID |
Naam | Type | Omschrijving | |
---|---|---|---|
visits | hash |
{
index: { }date_time: date }client_id: integer |
Visits |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 | |
---|---|---|---|
saved | integer | Count of saved records | |
saved | integer | Count of saved records | |
errors | array | Errors of not saved records |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 | |
---|---|---|---|
groups | hash |
{
index: { }group_id: integer }group_name: string group_values: hash { index: { }username: string }mailing_lastname: string mailing_name: string members_mob_phone: string password: string mailing_interjection: string mailing_email: string |
Groups |
Naam | Type | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
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 | verplicht | Omschrijving | Geldige waardes |
---|---|---|---|---|
method | string | 'get_inscription_invoice_date' constant | ||
key | string | Security key | ||
params[inscription_id] | integer | Inscription ID | ||
params[start_date] | date | Inscription start date, YYYY-DD-MM format | ||
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 | |||
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[payment_method_id] | integer | true | Payment method type, 1 = Cash, 2 = Bank, 3 = PIN, 10 = Online | 1, 2, 3, 10 |
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 |