GET: ALL CLIENTS

Type: GET

Method: clients

Parameter: none

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

Response Example:
{
    "status": "success",
    "response": [
        {
            "id": "21",
            "users_id": "654",
            "client_settings_id": "42",
            "avail_id": "503",
            "first_name": "Joe",
            "last_name": "Smith",
            "address1": "6545 New Street East",
            "address2": "101",
            "city": "Milton",
            "state": "Ontario",
            "zipcode": "L7D 5S2",
            "country": "Canada",
            "p_phone": "(905) 454-6464",
            "s_phone": "(416) 567-1144"
        },
        {
            ...
        }
    ]
}

Element Properties:
ELEMENT TYPE DESCRIPTION
id integer Unique id.
users_id integer Unique id. id on the users table
client_settings_id integer Unique id. id on the client_settings table
avail_id integer Unique id. id on the avail table
first_name string First name for the client
last_name string Last name for the client
address1 string Street address for the client
address2 string Suite or appartment number for the client
city string City location for the client
state string State location for the client
zipcode string Zipcode location for the client
country string Country location for the client
p_phone string Primary phone number for the client
s_phone string Secondary phone number for the client

GET: CLIENT

Type: GET

Method: client

Parameter: (integer) {client_id}

URL Example: https://www.bizstim.com/api/client/21

Response Example:
{
    "status": "success",
    "response": {
        "id": "21",
        "users_id": "654",
        "client_settings_id": "42",
        "avail_id": "503",
        "first_name": "Joe",
        "last_name": "Smith",
        "address1": "6545 New Street East",
        "address2": "101",
        "city": "Milton",
        "state": "Ontario",
        "zipcode": "L7D 5S2",
        "country": "Canada",
        "p_phone": "(905) 454-6464",
        "s_phone": "(416) 567-1144"
    }
}

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

GET: CLIENT SETTINGS

Type: GET

Method: clientsettings

Parameter: (integer) {client_settings_id}

URL Example: https://www.bizstim.com/api/clientsettings/42

Response Example:
{
    "status": "success",
    "response": {
        "id": "42",
        "status": "active",
        "funnel_id": "11",
        "calendar_color": "#0000ff",
        "start_date": "2018-02-11",
        "notes": "<p>This is a wonderful note for a fictional student named, Joe Smith.</p>",
        "send_welcome_message": "0",
        "send_lesson_reminders": "0",
        "see_practs_information": "1"
    }
}

Element Properties:
ELEMENT TYPE DESCRIPTION
id integer Unique id.
status string active | inactive | prospect
funnel_id integer Unique id. id on the client_funnel table
calendar_color string Not currently in use.
start_date string Date the client was added to the database
notes string Client notes as seen on the add, edit, and view client pages. This is not the sales manager notes
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_practs_information integer See practitioners contact information. 0 = no, 1 = yes

GET: ALL TESTIMONIALS

Type: GET

Method: testimonials

Parameter: none

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

Response Example:
{
    "status": "success",
    "response": [
        {
            "id": "54",
            "client_id": "57",
            "testimonial": "<p>an posuere sapien, eu tempus sapien porta in.
                    Curabitur posuere neque non quam hendrerit ornare. Mauris ut molestie lorem.
                    Aenean varius magna in vehicula ultrices. Nullam euismod consequat erat, ut
                    vestibulum purus egestas at. Aenean ultrices, quam pellentesque auctor finibus,
                    enim risus porttitor</p>",
            "first_name": "Funnel",
            "last_name": "Client"
        },
        {
            "id": "72",
            "client_id": "651",
            "testimonial": "<p>an posuere sapien, eu tempus sapien porta in.
                    Curabitur posuere neque non quam hendrerit ornare. Mauris ut molestie lorem.
                    Aenean varius magna in vehicula ultrices. Nullam euismod consequat erat, ut
                    vestibulum purus egestas at. Aenean ultrices, quam pellentesque auctor finibus,
                    enim risus porttitor an posuere sapien, eu tempus sapien porta in. Curabitur
                    posuere neque non quam hendrerit ornare. Mauris ut molestie lorem. Aenean varius
                    magna in vehicula ultrices.</p>",
            "first_name": "George",
            "last_name": "Mann"
        },
        {
            ...
        }
    ]
}

Element Properties:
ELEMENT TYPE DESCRIPTION
id integer Unique id. Testimonials id.
client_id integer Unique id. id for the clients table
testimonial string The client testimonial
first_name string The client's first name from the clients table
last_name string The client's last name from the clients table
The response data comes from a table join between the clients and testimonials tables.