API documentation

GET /api/v1/state_business_hours
List State Call Time records.

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id company_id states name monday_open_at monday_close_at tuesday_open_at tuesday_close_at wednesday_open_at wednesday_close_at thursday_open_at thursday_close_at friday_open_at friday_close_at saturday_open_at saturday_close_at sunday_open_at monday_closed tuesday_closed wednesday_closed thursday_closed friday_closed saturday_closed sunday_closed sunday_close_at template_description template_tier template_enabled template_copy_on_company_create template_id is_system_template Validations: Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/state_business_hours/new
Build State Call Time with defaults.

Params

Param name	Description Validations
states Optional Blank Value Allowed	States Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`
name Optional Blank Value Allowed	Name Validations: Must be a String
monday_open_at Optional Blank Value Allowed	Monday Open At Validations: Must be a decimal number.
monday_close_at Optional Blank Value Allowed	Monday Close At Validations: Must be a decimal number.
tuesday_open_at Optional Blank Value Allowed	Tuesday Open At Validations: Must be a decimal number.
tuesday_close_at Optional Blank Value Allowed	Tuesday Close At Validations: Must be a decimal number.
wednesday_open_at Optional Blank Value Allowed	Wednesday Open At Validations: Must be a decimal number.
wednesday_close_at Optional Blank Value Allowed	Wednesday Close At Validations: Must be a decimal number.
thursday_open_at Optional Blank Value Allowed	Thursday Open At Validations: Must be a decimal number.
thursday_close_at Optional Blank Value Allowed	Thursday Close At Validations: Must be a decimal number.
friday_open_at Optional Blank Value Allowed	Friday Open At Validations: Must be a decimal number.
friday_close_at Optional Blank Value Allowed	Friday Close At Validations: Must be a decimal number.
saturday_open_at Optional Blank Value Allowed	Saturday Open At Validations: Must be a decimal number.
saturday_close_at Optional Blank Value Allowed	Saturday Close At Validations: Must be a decimal number.
sunday_open_at Optional Blank Value Allowed	Sunday Open At Validations: Must be a decimal number.
sunday_close_at Optional Blank Value Allowed	Sunday Close At Validations: Must be a decimal number.

POST /api/v1/state_business_hours
Create State Call Time.

Params

Param name	Description Validations
states Optional Blank Value Allowed	States Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`
name Optional Blank Value Allowed	Name Validations: Must be a String
monday_open_at Optional Blank Value Allowed	Monday Open At Validations: Must be a decimal number.
monday_close_at Optional Blank Value Allowed	Monday Close At Validations: Must be a decimal number.
tuesday_open_at Optional Blank Value Allowed	Tuesday Open At Validations: Must be a decimal number.
tuesday_close_at Optional Blank Value Allowed	Tuesday Close At Validations: Must be a decimal number.
wednesday_open_at Optional Blank Value Allowed	Wednesday Open At Validations: Must be a decimal number.
wednesday_close_at Optional Blank Value Allowed	Wednesday Close At Validations: Must be a decimal number.
thursday_open_at Optional Blank Value Allowed	Thursday Open At Validations: Must be a decimal number.
thursday_close_at Optional Blank Value Allowed	Thursday Close At Validations: Must be a decimal number.
friday_open_at Optional Blank Value Allowed	Friday Open At Validations: Must be a decimal number.
friday_close_at Optional Blank Value Allowed	Friday Close At Validations: Must be a decimal number.
saturday_open_at Optional Blank Value Allowed	Saturday Open At Validations: Must be a decimal number.
saturday_close_at Optional Blank Value Allowed	Saturday Close At Validations: Must be a decimal number.
sunday_open_at Optional Blank Value Allowed	Sunday Open At Validations: Must be a decimal number.
sunday_close_at Optional Blank Value Allowed	Sunday Close At Validations: Must be a decimal number.

GET /api/v1/state_business_hours/:id
Get State Call Time by id.

PUT /api/v1/state_business_hours/:id
Update State Call Time by id.

Params

Param name	Description Validations
states Optional Blank Value Allowed	States Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`
name Optional Blank Value Allowed	Name Validations: Must be a String
monday_open_at Optional Blank Value Allowed	Monday Open At Validations: Must be a decimal number.
monday_close_at Optional Blank Value Allowed	Monday Close At Validations: Must be a decimal number.
tuesday_open_at Optional Blank Value Allowed	Tuesday Open At Validations: Must be a decimal number.
tuesday_close_at Optional Blank Value Allowed	Tuesday Close At Validations: Must be a decimal number.
wednesday_open_at Optional Blank Value Allowed	Wednesday Open At Validations: Must be a decimal number.
wednesday_close_at Optional Blank Value Allowed	Wednesday Close At Validations: Must be a decimal number.
thursday_open_at Optional Blank Value Allowed	Thursday Open At Validations: Must be a decimal number.
thursday_close_at Optional Blank Value Allowed	Thursday Close At Validations: Must be a decimal number.
friday_open_at Optional Blank Value Allowed	Friday Open At Validations: Must be a decimal number.
friday_close_at Optional Blank Value Allowed	Friday Close At Validations: Must be a decimal number.
saturday_open_at Optional Blank Value Allowed	Saturday Open At Validations: Must be a decimal number.
saturday_close_at Optional Blank Value Allowed	Saturday Close At Validations: Must be a decimal number.
sunday_open_at Optional Blank Value Allowed	Sunday Open At Validations: Must be a decimal number.
sunday_close_at Optional Blank Value Allowed	Sunday Close At Validations: Must be a decimal number.

DELETE /api/v1/state_business_hours/:id
Destroy State Call Time by id.