API Documentation

GET: ALL SERVICES

Type: GET
Method: services
Parameter: (integer) {start} / {limit}
URL Example: https://www.bizstim.com/api/services/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.
group_id integer Unique id. id on the service_group_names table
group_num integer Number of sessions in the service tier / service package
service_description string Description for the service
service_cost float Client cost of the service (2 decimal places)
service_default_wage float Practitioner wage of the service (2 decimal places)
service_taxable integer Is the service taxable? (0=no, 1=yes)
service_type integer Fixed or hourly service (0=hourly, 1=fixed)
service_status integer Status for the service (0=inactive, 1=active, 2=deleted)
online_booking integer Show service in Booking Tool (0=no, 1=yes)
min_duration integer Minimum minutes required for session
max_duration integer Maximum minutes required for session
start_interval string When a session starts (0=none, 1=top of hour, 2=30 minutes after top of hour)
name string Name of the service package
{
    "status": "success",
    "total": 20,
    "response": [
        {
            "id": "19",
            "group_id": "12",
            "group_num": "20",
            "service_description": "Calculus Preparation",
            "service_cost": "42.50",
            "service_default_wage": "30.00",
            "service_taxable": "1",
            "service_type": "0",
            "service_status": "1",
            "online_booking": "1",
            "min_duration": "60",
            "max_duration": "60",
            "start_interval": "1",
            "name": "Gold Tutoring Plan (20 hours)"
        },
        {
            ...
        }
    ]
}

GET: SERVICE

Type: GET
Method: service
Parameter: (integer) {service_id}
URL Example: https://www.bizstim.com/api/service/19
ELEMENT TYPE DESCRIPTION
id integer Unique id.
group_id integer Unique id. id on the service_group_names table
group_num integer Number of sessions in the service tier / service package
service_description string Description for the service
service_cost float Client cost of the service (2 decimal places)
service_default_wage float Practitioner wage of the service (2 decimal places)
service_taxable integer Is the service taxable? (0=no, 1=yes)
service_type integer Fixed or hourly service (0=hourly, 1=fixed)
service_status integer Status for the service (0=inactive, 1=active, 2=deleted)
online_booking integer Show service in Booking Tool (0=no, 1=yes)
min_duration integer Minimum minutes required for session
max_duration integer Maximum minutes required for session
start_interval string When a session starts (0=none, 1=top of hour, 2=30 minutes after top of hour)
name string Name of the service package
{
    "status": "success",
    "response": {
        "id": "19",
        "group_id": "12",
        "group_num": "20",
        "service_description": "Calculus Preparation",
        "service_cost": "42.50",
        "service_default_wage": "30.00",
        "service_taxable": "1",
        "service_type": "0",
        "service_status": "1",
        "online_booking": "1",
        "min_duration": "60",
        "max_duration": "60",
        "start_interval": "1",
        "name": "Gold Tutoring Plan (20 hours)"
    }
}