API Documentation
\

\

Functions

ping()

ping(string $method, string $format, string $apikey, string $apikeynumber, string $pingText) : mixed

A sample function to simply test a connection to the webservice.

What ever is passed up in $pingText will be returned with the text "Ping worked: $pingText"

Parameters

string $method

This is the name of the method being called. Should always be "ping"
string $format

The format of the data returned. Options are "json" and "xml". Default = "xml"
string $apikey

This is information that you get from the StudioCloud 3.0 program.
string $apikeynumber

This is information that you get from the StudioCloud 3.0 program.
string $pingText

The text that will be returned by the method

Returns

mixed —

Either xml or json is returned depending on the $format value. Will return the text "Ping worked: $pingText"

createEvent()

createEvent(string $method, string $format, string $apikey, string $apikeynumber, string $eventName, string $startTime, string $endTime, string $isMillisecond, string $notes)

Create an event in the StudioCloud calendar. This event will be created with the Appointment type

Parameters

string $method

This is the name of the method being called. Should always be "createEvent"
string $format

The format of the data returned. Options are "json" and "xml". Default = "xml"
string $apikey

This is information that you get from the StudioCloud 3.0 program.
string $apikeynumber

This is information that you get from the StudioCloud 3.0 program.
string $eventName

The name of the appointment
string $startTime

When the appointment begins
string $endTime

When the appointment ends
string $isMillisecond

Whether or not the timestamps are in milliseconds or seconds. If "true" then milliseconds. If "false" then seconds
string $notes

The notes for this event

searchByName()

searchByName(string $method, string $format, string $apikey, string $apikeynumber, string $name)

Search for an event by name

Parameters

string $method

This is the name of the method being called. Should always be "searchByName"
string $format

The format of the data returned. Options are "json" and "xml". Default = "xml"
string $apikey

This is information that you get from the StudioCloud 3.0 program.
string $apikeynumber

This is information that you get from the StudioCloud 3.0 program.
string $name

The name to search for. This is a basic search that looks for anything surrounding the name that you are passing in. So for example, if you search for "App" then this will match "Appointment" and "John Doe's Appearance".

searchByDate()

searchByDate(string $method, string $format, string $apikey, string $apikeynumber, string $month, string $day, string $year)

Search for events on a specific day

Parameters

string $method

This is the name of the method being called. Should always be "searchByName"
string $format

The format of the data returned. Options are "json" and "xml". Default = "xml"
string $apikey

This is information that you get from the StudioCloud 3.0 program.
string $apikeynumber

This is information that you get from the StudioCloud 3.0 program.
string $month

The integer value of the month you are searching for. January = 1 - December = 12
string $day

The day of the month you are searching for
string $year

The year you are searching for

ping()

ping(string $method, string $format, string $apikey, string $apikeynumber, string $pingText) : mixed

A sample function to simply test a connection to the webservice.

What ever is passed up in $pingText will be returned with the text "Ping worked: $pingText"

Parameters

string $method

This is the name of the method being called. Should always be "ping"
string $format

The format of the data returned. Options are "json" and "xml". Default = "xml"
string $apikey

This is information that you get from the StudioCloud 3.0 program.
string $apikeynumber

This is information that you get from the StudioCloud 3.0 program.
string $pingText

The text that will be returned by the method

Returns

mixed —

Either xml or json is returned depending on the $format value. Will return the text "Ping worked: $pingText"

createClient()

createClient(string $method, string $format, string $apikey, string $apikeynumber, string $firstName, string $lastName, string $homeNumber, string $workNumber, string $cellNumber, string $street, string $city, string $state, string $zip, string $email, string $notes, string $isProspective, string $subject, string $message, string $sendEmail, string $leadType, string $leadDeadline)

Create a client in the StudioCloud account.

Parameters

string $method

This is the name of the method being called. Should always be "createClient"
string $format

The format of the data returned. Options are "json" and "xml". Default = "xml"
string $apikey

This is information that you get from the StudioCloud 3.0 program.
string $apikeynumber

This is information that you get from the StudioCloud 3.0 program.
string $firstName

First name of the new client
string $lastName

Last name of the new client
string $homeNumber

Client's home phone number
string $workNumber

Client's work phone number
string $cellNumber

Client's cell phone number
string $street

Client's street address
string $city

Client's city
string $state

Client's state
string $zip

Client's zip
string $email

Client's email
string $notes

Notes about the client
string $isProspective

Should be "true" or "false" depending on whether or not you want the client to be saved as a prospective client. If "true" then the client is saved as a prospective client. The default is "false".
string $subject

The subject line of the email that will be sent to your business.
string $message

The message that will be sent to your business.
string $sendEmail

If this is "true" then an email using subject and message will be sent to the email address that we have as the main contact email for your business. The default is "false"
string $leadType

This is the type of event or lead that your business is being contact regarding
string $leadDeadline

This is the date or deadline of the lead. This should be an epoch time in milliseconds.

searchByName()

searchByName(string $method, string $format, string $apikey, string $apikeynumber, string $name)

A function to search for clients by name

Parameters

string $method

This is the name of the method being called. Should always be "searchByName"
string $format

The format of the data returned. Options are "json" and "xml". Default = "xml"
string $apikey

This is information that you get from the StudioCloud 3.0 program.
string $apikeynumber

This is information that you get from the StudioCloud 3.0 program.
string $name

The first or last name that you are searching for