GET /api/v1/state_holidays
List State Holiday records.

Params

Param name
Description
ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String

fulltext
Optional

Search for any record that matches this text

  • Must be a String

time_zone
Optional

Date ranges will be parsed using this time zone.

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
  • holiday_dates
  • template_description
  • template_tier
  • template_enabled
  • template_copy_on_company_create
  • template_id
  • is_system_template
  • 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: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off


GET /api/v1/state_holidays/new
Build State Holiday with defaults.

Params

Param name
Description
states
Optional Blank Value Allowed

States

  • Must be an array of strings. EG: ["abc123", "xzy023"]

holiday_dates
Optional Blank Value Allowed

Holiday Dates

  • Must be an array of strings. EG: ["abc123", "xzy023"]

name
Optional Blank Value Allowed

Name

  • Must be a String


POST /api/v1/state_holidays
Create State Holiday.

Params

Param name
Description
states
Optional Blank Value Allowed

States

  • Must be an array of strings. EG: ["abc123", "xzy023"]

holiday_dates
Optional Blank Value Allowed

Holiday Dates

  • Must be an array of strings. EG: ["abc123", "xzy023"]

name
Optional Blank Value Allowed

Name

  • Must be a String


GET /api/v1/state_holidays/:id
Get State Holiday by id.


PUT /api/v1/state_holidays/:id
Update State Holiday by id.

Params

Param name
Description
states
Optional Blank Value Allowed

States

  • Must be an array of strings. EG: ["abc123", "xzy023"]

holiday_dates
Optional Blank Value Allowed

Holiday Dates

  • Must be an array of strings. EG: ["abc123", "xzy023"]

name
Optional Blank Value Allowed

Name

  • Must be a String


DELETE /api/v1/state_holidays/:id
Destroy State Holiday by id.