WOwodify
RecurringClass

Get Recurring Class

Gets a Recurring Class.

get/classes/recurring/{recurringclass_id}

Request

  • Base URL
    https://api.wodify.com/v1
  • URL
    https://api.wodify.com/v1/classes/recurring/{recurringclass_id}
  • Auth
    none declared. Required headers: x-api-key

Path parameters

recurringclass_idinteger required

Class Id

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Automations → Integrations page.

Response

Class Data

idinteger required

Class Id

namestring

Name

descriptionstring

Class Description

program_idinteger

Program Identifier

programstring

Program Name

location_idinteger

Location Identifier

locationstring

Location Name

start_datestring date

Start Date

recurring_class_end_type_idinteger

Recurring Class Ent Type Identifier

recurring_class_end_typestring

Recurring Class Ent Type Identifier

end_datestring date

End Date

occurrencesinteger

Nr occurrences for the recurring

start_timestring time

Start Time

end_timestring time

End Time

class_repeat_type_idinteger

Class Repeat Type Id

class_repeat_typestring

Class Repeat Type

class_repeat_custom_type_idinteger

Recurring Class Repeat Custom Type Identifier

class_repeat_custom_typestring

Recurring Class Repeat Custom Type

class_repeat_custom_stepinteger

The step when the custom class repeat type is selected (for instance 2 weeks)

reservation_openinteger

Number of [TIMEFORMAT] a client may register before the start time of class

reservation_open_time_format_idinteger

[TIMEFORMAT] unit for ReservationOpen

reservation_open_time_formatstring

[TIMEFORMAT] unit for ReservationOpen

reservation_closeinteger

Time in [TIMEFORMAT] before the start time of class when the class reservation window closes

reservation_close_time_format_idinteger

[TIMEFORMAT] unit for ReservationClose

reservation_close_time_formatstring

[TIMEFORMAT] unit for ReservationClose

reservation_close_time_relation_idinteger

[TimeRelationType] unit for Reservations Close

reservation_close_time_relationstring

[TimeRelationType] unit for Reservations Close

reservation_close_time_point_idinteger

[TimePointType] unit for Reservations Close

reservation_close_time_pointstring

[TimePointType] unit for Reservations Close

cancellation_timeinteger

Number of [TIMEFORMAT] a client may cancel before the start time of class

cancellation_time_format_idinteger

[TIMEFORMAT] unit for CancellationTime

cancellation_time_formatstring

[TIMEFORMAT] unit for CancellationTime

cancel_class_if_no_reservationsboolean

Cancel Class If No Reservations

cancel_class_timeinteger

Number of [TIMEFORMAT] before a class cancels if there are no reservations

cancel_class_time_format_idinteger

[TIMEFORMAT] unit for CancelClassTime

cancel_class_time_formatstring

[TIMEFORMAT] unit for CancelClassTime

cancel_class_number_reservationsinteger

Minimum number of reservations to NOT cancel a class

count_towards_attendance_limitsboolean

Count Towards Attendance Limits

waitlist_type_idinteger

The type of waitlist, indicating how the waitlist should behave. NULL or FirstReply - All clients emailed, first to reply gets added to class. PriorityWaitlist_FirstSignUp - Client automatically added to the class in the order they signed up.

waitlist_typestring

The type of waitlist, indicating how the waitlist should behave. NULL or FirstReply - All clients emailed, first to reply gets added to class. PriorityWaitlist_FirstSignUp - Client automatically added to the class in the order they signed up.

client_sign_is_enabledboolean

Indicates if the Client self sign in is enabled

client_sign_startinteger

Max Number of [TIMEFORMAT] a client may signin in advance

client_sign_start_time_format_idinteger

[TIMEFORMAT] unit for ClientSignStart

client_sign_start_time_formatstring

[TIMEFORMAT] unit for ClientSignStart

client_sign_end_resinteger

Min Number of [TIMEFORMAT] a client may signin in advance for classes with reservations enabled

client_sign_end_res_time_format_idinteger

[TIMEFORMAT] unit for ClientSignEndRes

client_sign_end_res_time_formatstring

[TIMEFORMAT] unit for ClientSignEndRes

client_sign_end_res_time_relation_idinteger

[TimeRelationType] unit for ClientSignEndRes

client_sign_end_res_time_relationstring

[TimeRelationType] unit for ClientSignEndRes

client_sign_end_res_time_point_idinteger

[TimePointType] unit for ClientSignEndRes

client_sign_end_res_time_pointstring

[TimePointType] unit for ClientSignEndRes

client_sign_end_no_resinteger

Min Number of [TIMEFORMAT] a client may signin in advance for classes without reservations enabled

client_sign_end_no_res_time_format_idinteger

[TIMEFORMAT] unit for ClientSignEndNoRes

client_sign_end_no_res_time_formatstring

[TIMEFORMAT] unit for ClientSignEndNoRes

client_sign_end_no_res_time_relation_idinteger

[TimeRelationType] unit for ClientSignEndNoRes

client_sign_end_no_res_time_relationstring

[TimeRelationType] unit for ClientSignEndNoRes

client_sign_end_no_res_time_point_idinteger

[TimePointType] unit for ClientSignEndNoRes

client_sign_end_no_res_time_pointstring

[TimePointType] unit for ClientSignEndNoRes

employee_sign_startinteger

Number of [TIMEFORMAT] an employee may signin in advance

employee_sign_start_time_format_idinteger

[TIMEFORMAT] unit for EmployeeSignStart

employee_sign_start_time_formatstring

[TIMEFORMAT] unit for EmployeeSignStart

count_late_cancellationsboolean

Indicates whether late cancellation counts towards attendance limits

charge_late_cancellation_feeboolean

Charge Late Cancellation Fee

late_cancellation_feenumber

Late Cancellation Fee

late_cancellation_fee_tax_rate_idinteger

Late Cancellation Fee Tax Rate Identifier

late_cancellation_fee_tax_ratestring

Late Cancellation Fee Tax Rate

count_no_show_reservationsboolean

Indicates whether no-shows count towards attendance limits

charge_no_show_feeboolean

Charge No-Show Fee

no_show_feenumber

No-Show Fee

no_show_fee_tax_rate_idinteger

No-Show Fee Tax Rate Identifier

no_show_fee_tax_ratestring

No-Show Fee Tax Rate

room_idinteger

Room Id

roomstring

Room Name

layout_idinteger

Layout Id

layoutstring

Layout Name

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions:

  • an UserException with Abort Transaction = Yes, and a Log Error = No
  • an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

Example response

{
  "program_id": 1234567891234567,
  "location_id": 1234567891234567,
  "start_date": "2014-12-31",
  "recurring_class_end_type_id": 1234567891234567,
  "end_date": "2014-12-31",
  "start_time": "23:59:59",
  "end_time": "23:59:59",
  "class_repeat_type_id": 1234567891234567,
  "class_repeat_custom_type_id": 1234567891234567,
  "reservation_open_time_format_id": 1234567891234567,
  "reservation_close_time_format_id": 1234567891234567,
  "reservation_close_time_relation_id": 1234567891234567,
  "reservation_close_time_point_id": 1234567891234567,
  "cancellation_time_format_id": 1234567891234567,
  "cancel_class_time_format_id": 1234567891234567,
  "waitlist_type_id": 1234567891234567,
  "client_sign_start_time_format_id": 1234567891234567,
  "client_sign_end_res_time_format_id": 1234567891234567,
  "client_sign_end_res_time_relation_id": 1234567891234567,
  "client_sign_end_res_time_point_id": 1234567891234567,
  "client_sign_end_no_res_time_format_id": 1234567891234567,
  "client_sign_end_no_res_time_relation_id": 1234567891234567,
  "client_sign_end_no_res_time_point_id": 1234567891234567,
  "employee_sign_start_time_format_id": 1234567891234567,
  "late_cancellation_fee": 0.1,
  "late_cancellation_fee_tax_rate_id": 1234567891234567,
  "no_show_fee": 0.1,
  "no_show_fee_tax_rate_id": 1234567891234567,
  "room_id": 1234567891234567,
  "layout_id": 1234567891234567,
  "sunday": {
    "non_client_drop_in_fee": 0.1,
    "client_drop_in_fee": 0.1,
    "coaches": [
      {
        "coach_id": 1234567891234567,
        "pay_rate_id": 1234567891234567,
        "payroll_position_id": 1234567891234567
      }
    ]
  },
  "monday": {
    "non_client_drop_in_fee": 0.1,
    "client_drop_in_fee": 0.1,
    "coaches": [
      {
        "coach_id": 1234567891234567,
        "pay_rate_id": 1234567891234567,
        "payroll_position_id": 1234567891234567
      }
    ]
  },
  "tuesday": {
    "non_client_drop_in_fee": 0.1,
    "client_drop_in_fee": 0.1,
    "coaches": [
      {
        "coach_id": 1234567891234567,
        "pay_rate_id": 1234567891234567,
        "payroll_position_id": 1234567891234567
      }
    ]
  },
  "wednesday": {
    "non_client_drop_in_fee": 0.1,
    "client_drop_in_fee": 0.1,
    "coaches": [
      {
        "coach_id": 1234567891234567,
        "pay_rate_id": 1234567891234567,
        "payroll_position_id": 1234567891234567
      }
    ]
  },
  "thursday": {
    "non_client_drop_in_fee": 0.1,
    "client_drop_in_fee": 0.1,
    "coaches": [
      {
        "coach_id": 1234567891234567,
        "pay_rate_id": 1234567891234567,
        "payroll_position_id": 1234567891234567
      }
    ]
  },
  "friday": {
    "non_client_drop_in_fee": 0.1,
    "client_drop_in_fee": 0.1,
    "coaches": [
      {
        "coach_id": 1234567891234567,
        "pay_rate_id": 1234567891234567,
        "payroll_position_id": 1234567891234567
      }
    ]
  },
  "saturday": {
    "non_client_drop_in_fee": 0.1,
    "client_drop_in_fee": 0.1,
    "coaches": [
      {
        "coach_id": 1234567891234567,
        "pay_rate_id": 1234567891234567,
        "payroll_position_id": 1234567891234567
      }
    ]
  },
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.