GET: ALL PRACTITIONERS

Type: GET

Method: practitioners

Parameter: none

URL Example: https://www.bizstim.com/api/practitioners

Response Example:
{
    "status": "success",
    "response": [
        {
            "id": "81",
            "users_id": "176",
            "pract_settings_id": "92",
            "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"
        },
        {
            ...
        }
    ]
}

Element Properties:
ELEMENT TYPE DESCRIPTION
id integer Unique id.
users_id integer Unique id. id on the users table
pract_settings_id integer Unique id. id on the pract_settings table
avail_id integer Unique id. id on the avail table
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

GET: MEET OUR TEAM

Type: GET

Method: meetourteam

Parameter: none

URL Example: https://www.bizstim.com/api/meetourteam

Response Example:
{
    "status": "success",
    "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"
        },
        {
             ...
        }
    ]
}

Element Properties:
ELEMENT TYPE DESCRIPTION
admin_id integer Unique id. id on the practs table
pract_settings_id integer Unique id. id on the pract_settings table
pract_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}

Additional Information

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.  

GET: PRACTITIONER

Type: GET

Method: practitioner

Parameter: {pract_id}

URL Example:https://www.bizstim.com/api/practitioner/81

Response Example:
{
    "status": "success",
    "response": {
        "id": "81",
        "users_id": "176",
        "pract_settings_id": "92",
        "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"
    }
}

* See element properties from PRACTITIONERS for a list of the elements and their properties.

GET: PRACTITIONER SETTINGS

Type: GET

Method: practitionersettings

Parameter: {pract_settings_id}

URL Example: https://www.bizstim.com/api/practitionersettings/92

Response Example:
{
    "status": "success",
    "response": {
        "id": "92",
        "status": "active",
        "calendar_color": "#38761d",
        "hire_date": "2017-11-28",
        "wage_tier": "0",
        "add_value": "0.00",
        "notes": "<p>This is a note</p>",
        "send_welcome_message": "0",
        "send_lesson_reminders": "0",
        "see_clients_information": "1",
        "see_costs_wages": "1",
        "see_other_appointments": "1",
        "set_session_control": "2",
        "can_reconcile_duration": "1"
    }
}

Element Properties:
ELEMENT TYPE DESCRIPTION
id integer Unique id.
status string active | inactive | contactList | doNotHire
calendar_color string Color of blocks shown on the session calendar
hire_date string Date the practitioner was added to the database
wage_tier integer Wage type for the practitioner. 0 = hourly | 1 = hourly salary | 2 = annual salary
add_value float Dollar amount to be added to hourly or fixed wages. Does noT affect salary earners or earners who use timesheets to track their wages. This only affects those practitioners who are paid based on their missed or completed sessions. This float has a precision to two (2) decimal places
notes string Practitioner notes as seen on the add, edit, and view practitioner pages
send_welcome_message integer Send welcome message upon account creation. 0 = no, 1 = yes
send_lesson_reminders integer Send lesson reminders via e-mail. 0 = no, 1 = yes
see_clients_information integer The practitioner can see the clients contact information. 0 = no, 1 = yes
see_costs_wages integer The practitioner can see the costs and wages of a session. 0 = no, 1 = yes
see_other_appointments integer The practitioner can see all sessions on the calendar including those of other practitioners. They have access to a limited amount of session information. 0 = no, 1 = yes
set_session_control integer Controls the options practitioners can exercise. 0 = view sessions only | 1 = view, edit, and save sessions | 2 = view, edit, save, and delete sessions
can_reconcile_duration integer The practitioner can change the time of the session. 0 = no, 1 = yes