API Documentation

GET: ALL PRACTITIONERS

Type: GET
Method: practitioners
Parameter: (integer) {start} / {limit}
URL Example: https://www.bizstim.com/api/practitioners/0/20
start parameter refers to the first record to return.  Default = 0.
limit parameter refers to the number of records to return.  Default = 20.  Maximum = 100.
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.
ELEMENT TYPE DESCRIPTION
id integer Unique practitioner id.
pract_settings_id integer Unique id. id on the pract_settings table
users_id integer Unique id. id on the users table
avail_id string Comma separated avail_id's on the avail table. For example: 123,546,971. This example has 1 default schedule and 2 alternative schedules.
first_name string First name for the practitioner
last_name string Last name for the practitioner
address1 string Street address for the practitioner
address2 string Suite or appartment number for the practitioner
city string City location for the practitioner
state string State location for the practitioner
zipcode string Zipcode location for the practitioner
country string Country location for the practitioner
p_phone string Primary phone number for the practitioner
s_phone string Secondary phone number for the practitioner
text_phone string Text message phone number for the practitioner
{
    "status": "success",
    "total": 10,
    "response": [
        {
            "id": "81",
            "pract_settings_id": "125",
            "users_id": "176",
            "avail_id": "282",
            "first_name": "jennifer",
            "last_name": "Billings",
            "address1": "156 Main Street West",
            "address2": "501",
            "city": "Hamilton",
            "state": "Ontario",
            "zipcode": "L9H 2H6",
            "country": "Canada",
            "p_phone": "(905) 444-3333",
            "s_phone": "(905) 444-7777",
            "text_phone": "19054443333"
        },
        {
            ...
        }
    ]
}

GET: MEET OUR TEAM

Type: GET
Method: meetourteam
Parameter: (integer) {start} / {limit}
URL Example: https://www.bizstim.com/api/meetourteam/0/20
start parameter refers to the first record to return.  Default = 0.
limit parameter refers to the number of records to return.  Default = 20.  Maximum = 100.
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.
ELEMENT TYPE DESCRIPTION
admin_id integer Unique id. id on the practs table
pract_id integer Unique id. id on the practs table
pract_settings_id integer Unique id. id on the practs table
first_name string First name for the practitioner
last_name string Last name for the practitioner
position string Practitioner's position with the company. For example; Math Teacher, ABA Therapist, Orthodontist. 100 character maximum length
excerpt string A short description of the practitioners roles and responsibilities. 210 character maximum length
priority integer Choose a number between 1 and 100. 1 has the highest priority. This is used to determine the order of appearance for our Meet Our Team API and WordPress plugin. You can keep this at the default setting if you do not intend to use the API.
headshot_url string

Filename of an image or pic that has been uploaded to their account by the administrator. This will be blank.png for those who do not have a pic. This field could also be an empty string.

If this value is empty or blank.png, use the following url to point to the file:

https://www.bizstim.com/assets/backend/images/headshots/blank.png

If this value is not empty and is not blank.png, use the following url to point to the file:

https://www.bizstim.com/assets/backend/images/headshots/practs/admin-{admin_id}/pract-{pract_settings_id}/{headshot_url}

ORDER OF THE QUERY.   The response is ordered by priority in ascending order.   If two or more practitioners have the same priority, they are then ordered by first name in ascending order.   This was done to help you show the practitioners in a logical order that was previously predetermined by you.  
{
    "status": "success",
    "total": 73,
    "response": [
        {
            "admin_id": "74",
            "pract_id": "549",
            "pract_settings_id": "679",
            "first_name": "Joanne",
            "last_name": "Prettiton",
            "position": "ABA Therapist",
            "excerpt": "<p>Scelerisque fringilla nulla ut vulputate. Aenean elementum lacus
                ipsum, a scelerisque metus consequat auctor. Nullam a ullamcorper lorem. Curabitur consectetur
                auctor tempor. Proin venenatis purus sed diam vehicula interdum. Ut sit amet tempus tellus.
                Nam id turpis vitae sem lobortis tincidunt. Nulla facilisi.</p>",
            "priority": "10",
            "headshot_url": "joanne.png"
        },
        {
             ...
        }
    ]
}

GET: PRACTITIONER

Type: GET
Method: practitioner
Parameter: {pract_id}
URL Example:https://www.bizstim.com/api/practitioner/81
ELEMENT TYPE DESCRIPTION
id integer Unique practitioner id.
pract_settings_id integer Unique id. id on the pract_settings table
users_id integer Unique id. id on the users table
avail_id string Comma separated avail_id's on the avail table. For example: 123,546,971. This example has 1 default schedule and 2 alternative schedules.
first_name string First name for the practitioner
last_name string Last name for the practitioner
address1 string Street address for the practitioner
address2 string Suite or appartment number for the practitioner
city string City location for the practitioner
state string State location for the practitioner
zipcode string Zipcode location for the practitioner
country string Country location for the practitioner
p_phone string Primary phone number for the practitioner
s_phone string Secondary phone number for the practitioner
text_phone string Text message phone number for the practitioner
status string Status types include: active, inactive, contactList, doNotHire
calendar_color string Hex color code: e.g. #8874bc
hire_date string YYYY-mm-dd: e.g. 2020-04-28
wage_tier integer Wages include: 0 = hourly, 1 = salary hourly, 2 = salary annual
add_value float Dollar value to 2 decimal places: e.g. 2.75
notes string Information on the practitioner
position string Position name you provide
excerpt string Information about the practitioner
priority integer A number between 1 and 100 where the lower the number the greater the value. Priority 1 will be shown first and priority 100 practitioners will be shown last
headshot_url string

Filename of an image or pic that has been uploaded to their account by the administrator. This will be blank.png for those who do not have a pic. This field could also be an empty string.

If this value is empty or blank.png, use the following url to point to the file:

https://www.bizstim.com/assets/backend/images/headshots/blank.png

If this value is not empty and is not blank.png, use the following url to point to the file:

https://www.bizstim.com/assets/backend/images/headshots/practs/admin-{admin_id}/pract-{pract_settings_id}/{headshot_url}

send_welcome_message integer 0 = no, 1 = yes
send_lesson_reminders integer 0 = no, 1 = yes
text_reminders integer 0 = no, 1 = yes
see_clients_information integer 0 = no, 1 = yes
team_assess integer 0 = no, 1 = yes
see_costs_wages integer 0 = no view, 1 = view wages, 2 = view wages and costs
see_other_appointments integer 0 = no, 1 = yes
set_session_control integer 0 = view 1 = view, save 2 = view, save, edit 3 = view, save, edit, add 4 = view, save, edit, add, delete
can_reconcile_duration integer 0 = no, 1 = yes
set_breaks integer 0 = no, 1 = yes
use_records integer 0 = no, 1 = view, 2 = edit, 3 = delete
multi_practs integer 0 = no, 1 = yes
online_booking integer 0 = no, 1 = yes
email string String of comma separated emails: e.g. email1@mail.com,email2@mail.com
calendar 1 = month, 2 = week, 3 = day
minTime string Default = 08:00:00
maxTime string Default = 24:00:00
slotDuration string Default = 00:15:00 or 15 minute intervals
sessionLimit integer Number of sessions to show per day in month view. Default = 10
cal_length integer Length of the calendar on the page in pixels. Default = 1200
{
    "status": "success",
    "response": {
        "id": "81",
        "pract_settings_id": "125",
        "users_id": "176",
        "avail_id": "282",
        "first_name": "jennifer",
        "last_name": "Billings",
        "address1": "156 Main Street West",
        "address2": "501",
        "city": "Hamilton",
        "state": "Ontario",
        "zipcode": "L9H 2H6",
        "country": "Canada",
        "p_phone": "(905) 444-3333",
        "s_phone": "(905) 444-7777",
        "text_phone": "19054443333"
        "status": "active"
        "calendar_color": "#8874bc"
        "hire_date": "2018-04-28"
        "wage_tier": "0"
        "add_value": "0.00"
        "notes": "Vestibulum scelerisque fringilla nulla ut vulputate. Aenean elementum lacus ipsum, a scelerisque metus consequat auctor. Nullam a ullamcorper lorem. Curabitur consectetur auctor tempor. Proin venenatis purus sed diam vehicula interdum. Ut sit amet tempus tellus. Nam id turpis vitae sem lobortis tincidunt. Nulla facilisi."
        "position": "Founder and CEO"
        "excerpt": "Scelerisque fringilla nulla ut vulputate. Aenean elementum lacus ipsum, a scelerisque metus consequat auctor. Nullam a ullamcorper lorem. Curabitur consectetur auctor tempor. Proin venenatis purus sed diam."
        "priority": "10"
        "headshot_url": "joanne.png"
        "send_welcome_message": "0"
        "send_lesson_reminders": "1"
        "text_reminders": "1"
        "see_clients_information": "0"
        "team_assess": "0"
        "see_costs_wages": "1"
        "see_other_appointments": "0"
        "set_session_control": "0"
        "can_reconcile_duration": "0"
        "set_breaks": "0"
        "use_records": "0"
        "multi_practs": "0"
        "online_booking": "1"
        "email": "susan@mail.com, joe@mail.com"
        "calendar": "1"
        "minTime": "11:30:00"
        "maxTime": "22:00:00"
        "slotDuration": "00:15:00"
        "sessionLimit": "10"
        "cal_length": "1200"
    }
}