TABLE OF CONTENTS GET: Availability GET: User Login Information

GET: AVAILABILITY

Type: GET

Method: availability

Parameter: (integer) {avail_id}

URL Example: https://www.bizstim.com/api/availability/504

Response Example: 
{
    "status": "success",
    "response": {
        "id": "504",
        "label": "Default",
        "start": "2019-09-03",
        "end": "2020-06-28",
        "mAvailf": "12:30",
        "mAvailt": "17:30",
        "tAvailf": "12:30",
        "tAvailt": "19:30",
        "wAvailf": "12:30",
        "wAvailt": "21:31",
        "rAvailf": "12:30",
        "rAvailt": "21:31",
        "fAvailf": "12:30",
        "fAvailt": "20:31",
        "satAvailf": "12:30",
        "satAvailt": "19:31",
        "sunAvailf": "12:30",
        "sunAvailt": "16:31"
    }
}

Element Properties:
ELEMENT TYPE DESCRIPTION
id integer Unique id.
label string 20 character limit describing the alternative schedule. "Default" present for the default schedule.
start string Date in the format: YYYY-MM-DD.
end string Date in the format: YYYY-MM-DD.
mAvailf string Monday start time availability. Uses 24 hour time with a range of 00:00 to 24:00
mAvailt string Monday end time availability. Uses 24 hour time with a range of 00:00 to 24:00
tAvailf string Tuesday start time availability. Uses 24 hour time with a range of 00:00 to 24:00
tAvailt string Tuesday end time availability. Uses 24 hour time with a range of 00:00 to 24:00
wAvailf string Wednesday start time availability. Uses 24 hour time with a range of 00:00 to 24:00
wAvailt string Wednesday end time availability. Uses 24 hour time with a range of 00:00 to 24:00
rAvailf string Thursday start time availability. Uses 24 hour time with a range of 00:00 to 24:00
rAvailt string Thursday end time availability. Uses 24 hour time with a range of 00:00 to 24:00
fAvailf string Friday start time availability. Uses 24 hour time with a range of 00:00 to 24:00
fAvailt string Friday end time availability. Uses 24 hour time with a range of 00:00 to 24:00
satAvailf string Saturday start time availability. Uses 24 hour time with a range of 00:00 to 24:00
satAvailt string Saturday end time availability. Uses 24 hour time with a range of 00:00 to 24:00
sunAvailf string Sunday start time availability. Uses 24 hour time with a range of 00:00 to 24:00
sunAvailt string Sunday end time availability. Uses 24 hour time with a range of 00:00 to 24:00

GET: USER LOGIN INFORMATION

Type: GET

Method: userlogin

Parameter: (integer) {users_id}

URL Example: https://www.bizstim.com/api/userlogin/3941

Response Example: 
{
    "status": "success",
    "response": {
        "id": "3941",
        "username": "clientusername",
        "email": "useremail@gmail.com"
    }
}

Element Properties:
ELEMENT TYPE DESCRIPTION
id integer Unique id.
username string Username for login and password retrieval. *** The username field is very important *** To request a password reset the user must remember their username. This field MUST be unique to any other user
email string E-mail address for password reset and other software functions. The email field does not need to be unique because you could have a practitioner working for several companies using the business software.