CRM API GET Methods | Users | Bizstim Software Solutions

TABLE OF CONTENTS GET: Availability GET: Custom Data GET: User Login Information

GET: AVAILABILITY

Type: GET

Method: availability

Parameter: (integer) {avail_id}

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

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

{
    "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"
    }
}

GET: CUSTOM DATA (CUSTOM POST TYPES)

Type: GET

Method: customdata

Parameter: (integer) {start} / {limit}

URL Example: https://www.bizstim.com/api/customdata/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 id.
`user`	string	Currently only `client` is available. When custom post types are made available to other user types this field will have other options.
`type`	string	Currently only `text` is available. When other custom post types are made available this field will have other options.
`public`	string	You may select `public` or `private`. Public custom post types can be viewed by all users. Private custom post types can be view by the administrator and staff only.
`label`	string	Label for the custom post type. For example, Graduation Year or Date of Birth
`order_custom`	integer	A number denoting the custom post types order among similar data. For example, 1 is the first to appear in a list of custom data.

{
    "status": "success",
    "total": 17,
    "response": [
        {
            "id": "11",
            "user": "client",
            "type": "text",
            "public": "public"
            "label": "Graduation Year"
            "order_custom": "3"
        },
        {
            ...
        }
    ]
}

Type: GET

Method: userlogin

Parameter: (integer) {users_id}

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

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.

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

We'll give you $120 credit to switch to Bizstim!

API Documentation

GET: AVAILABILITY

GET: CUSTOM DATA (CUSTOM POST TYPES)

GET: USER LOGIN INFORMATION