GET: ALL SESSIONS
Type:
GET
Method:
sessions
Parameter:
(integer)
{start} / {limit}
URL Example:
https://www.bizstim.com/api/sessions/0/100
start parameter refers to the first record to return. Default = 0.limit parameter refers to the number of records to return. Default = 100. Maximum = 1000.start and limit can be omitted from the URL and their defaults will be chosen.total key in the json object is the total number of records found. Use this to create your own pagination.timezone Default timezone for the account. The session dates and times are saved according to this timezone.| ELEMENT | TYPE | DESCRIPTION |
|---|---|---|
id |
integer | Unique id. |
confirmed |
integer | 0=pending, 1=confirmed |
multi |
integer | 0=single session, 1=group session |
slots |
integer | number of total participants allowed |
class_id |
integer | unique id for the class |
display |
integer | 1=display, 0=do not display | Do we display the session on the group sessions list within the online, group booking tool? |
pract_d |
integer | unique id for the practitioner |
wage_id |
integer | unique id for the wage earnings |
client_id |
integer | unique id for the client |
client_due_id |
integer | unique id for the client cost |
cancel_clients |
string | when a client cancels from a group session the following data is stored: client_id|client_dues_id|session_id_of_temp_session => 76|2328|479889,49|2329|479895 |
temp |
string | when a client cancels from a group sessions but the session has not been completed yet the following data is stored temporarily: 0=not a temp, session_id for original session |
service_id |
integer | unique id for the service |
location_id |
integer | unique id for the location |
recurr_id |
integer | unique id for the recurring series |
recurr_on |
integer | 0=no recurring series, 1=session is in a recurring series |
qb_invoice_id |
string | id of invoice created when a session is completed/saved. This is generated by QuickBooks |
session_status |
integer | 0=open, 1=canceled, 2=missed, 3=saved |
custom_map_id |
integer | custom map id from the custom_mapping table |
session_reminder |
integer | 0=no reminder sent, 1=reminder sent |
session_sms |
integer | has the session had a text reminder sent out: 0=no, 1=yes |
session_description |
string | description for the session. Also known as the session title or label |
session_date |
string | date of the session saved in the default timezone |
session_start_time |
string | start time of the session saved in the default timezone |
session_end_time |
string | end of the session saved in the default timezone |
session_note |
string | public note for the session. All participants can see this note |
session_private_note |
string | private note for the session. The client cannot see this note |
session_other_note |
string | marketing information for the session. This is used for open group sessions that can be joined by clients from the online booking tool |
assessment_moderation |
integer | does the session need to be moderated by the administrator or a staff user? 0=no moderation, 1=moderate |
assessment_present |
integer | is there an assessment present for the session? 0=no assessment, 1=assessment present |
{
"status": "success",
"total": 20,
"timezone": "America/Los_Angeles",
"response": [
{
"id": "1135",
"confirmed": "1",
"multi": "0",
"slots": "0",
"class_id": "0",
"display": "1",
"pract_id": "354",
"wage_id": "54",
"client_id": "49",
"client_due_id": "54",
"cancel_clients": "",
"temp": "0",
"service_id": "19",
"location_id": "24",
"recurr_id": "1",
"recurr_on": "0",
"qb_invoice_id": "0",
"session_status": "3",
"custom_map_id": "0",
"session_reminder": "0",
"session_sms": "0",
"session_description": "Test Session",
"session_date": "2021-04-28",
"session_start_time": "17:00",
"session_end_time": "18:00",
"session_note": "This is a public session note | John Doe 2021-04-16 | 11:25 am PDT",
"session_private_note": "John Doe 2021-04-13 | 8:28 am PDT | Added by administrator",
"session_other_note": "",
"assessment_moderation": "0",
"assessment_present": "1"
},
{
...
}
]
}
GET: SESSION
Type:
GET
Method:
session
Parameter:
(integer)
{session_id}
URL Example:
https://www.bizstim.com/api/session/24
timezone Default timezone for the account. The session dates and times are saved according to this timezone.| ELEMENT | TYPE | DESCRIPTION |
|---|---|---|
id |
integer | Unique id. |
confirmed |
integer | 0=pending, 1=confirmed |
multi |
integer | 0=single session, 1=group session |
slots |
integer | number of total participants allowed |
class_id |
integer | unique id for the class |
display |
integer | 1=display, 0=do not display | Do we display the session on the group sessions list within the online, group booking tool? |
pract_d |
integer | unique id for the practitioner |
wage_id |
integer | unique id for the wage earnings |
client_id |
integer | unique id for the client |
client_due_id |
integer | unique id for the client cost |
cancel_clients |
string | when a client cancels from a group session the following data is stored: client_id|client_dues_id|session_id_of_temp_session => 76|2328|479889,49|2329|479895 |
temp |
string | when a client cancels from a group sessions but the session has not been completed yet the following data is stored temporarily: 0=not a temp, session_id for original session |
service_id |
integer | unique id for the service |
location_id |
integer | unique id for the location |
recurr_id |
integer | unique id for the recurring series |
recurr_on |
integer | 0=no recurring series, 1=session is in a recurring series |
qb_invoice_id |
string | id of invoice created when a session is completed/saved. This is generated by QuickBooks |
session_status |
integer | 0=open, 1=canceled, 2=missed, 3=saved |
custom_map_id |
integer | custom map id from the custom_mapping table |
session_reminder |
integer | 0=no reminder sent, 1=reminder sent |
session_sms |
integer | has the session had a text reminder sent out: 0=no, 1=yes |
session_description |
string | description for the session. Also known as the session title or label |
session_date |
string | date of the session saved in the default timezone |
session_start_time |
string | start time of the session saved in the default timezone |
session_end_time |
string | end of the session saved in the default timezone |
session_note |
string | public note for the session. All participants can see this note |
session_private_note |
string | private note for the session. The client cannot see this note |
session_other_note |
string | marketing information for the session. This is used for open group sessions that can be joined by clients from the online booking tool |
assessment_moderation |
integer | does the session need to be moderated by the administrator or a staff user? 0=no moderation, 1=moderate |
assessment_present |
integer | is there an assessment present for the session? 0=no assessment, 1=assessment present |
{
"status": "success",
"timezone": "America/Los_Angeles",
"response": {
"id": "1139",
"confirmed": "1",
"multi": "1",
"slots": "20",
"class_id": "0",
"display": "1",
"pract_id": "354",
"wage_id": "0",
"client_id": "49",
"client_due_id": "0",
"cancel_clients": "",
"temp": "0",
"service_id": "19",
"location_id": "24",
"recurr_id": "0",
"recurr_on": "0",
"qb_invoice_id": "0",
"session_status": "1",
"custom_map_id": "0",
"session_reminder": "0",
"session_sms": "0",
"session_description": "Open Group Session",
"session_date": "2021-04-27",
"session_start_time": "16:00",
"session_end_time": "18:00",
"session_note": "",
"session_private_note": "John Doe | 2021-04-16 | 11:44 am PDT | Added by administrator",
"session_other_note": "",
"assessment_moderation": "0",
"assessment_present": "0"
}
}