API Specifications

Accept

application/json

Content-Type

application/json

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].site_id

int

The ID of the site.

body[].site_name

String

The name of the site.

body[].address1

String

The first address line of the site.

body[].address2

String

The second address line of the site.

body[].city

String

The city of the site.

body[].state

String

The state of the site.

body[].zip_code

String

The zip code of the site.

body[].country

String

The country of the site.

body[].geographic_area

String

The geographic area of the site.

body[].email_address

String

The email address of the site.

Accept

application/json

Content-Type

application/json

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].organization_id

int

The ID of the organization.

body[].name

String

Name of the organization.

body[].country

String

The specified Default Country on the Configuration – General page.

body[].time_zone

String

The specified Time Zone on the Configuration – General page.

body[].logo_on_member_app

String

The URL of the ACTIVE Net Captivate App logo.

body[].retired

String

The retired flag of the organization, 'Y' for retired and 'N' for not retired.

body[].cui_url

String

The URL of the online site/CUI

Accept

application/json

Content-Type

application/json

show_on_member_app

String

Optional

Filter for centers by their 'Show On the ACTIVE Net Captivate App' flag: Y or N.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].center_id

int

The ID of the center.

body[].center_name

String

The name of the center.

body[].prevent_further_use

boolean

Prevent future use flag.

body[].site_id

int

The site ID of the site where the center belongs to.

body[].site_name

String

The name of the site where the center belongs to.

body[].show_on_member_app

String

Whether the center is displayed on the ACTIVE Net Captivate app: 'Y' or 'N'.

body[].member_app_image

String

The URL of the image which is displayed on the ACTIVE Net Captivate App > center details page.

body[].latitude

String

The latitude the center.

body[].longitude

String

The longitude of the center.

body[].description

String

The description of the center.

body[].customer_webpage_url

String

The text specified in the 'Customer Web Page URL' setting of the center.

body[].address1

String

The first address line of the center.

body[].address2

String

The second address line of the center.

body[].city

String

The city of the center.

body[].state

String

The state/province of the center.

body[].zip_code

String

The zip code of the center.

body[].country

String

The country of the center.

body[].phone1

String

The first phone number of the center.

body[].phone2

String

The second phone number of the center.

body[].fax

String

The fax number of the center.

body[].default_hours_of_operation

Object

Default opening and closing times of the center.

body[].default_hours_of_operation.default_opens

Time

Default opening time of the center.

body[].default_hours_of_operation.default_closes

Time

Default closing time of the center.

body[].Sunday_hours_of_operation

Object

Opening and closing time on Sundays.

body[].Sunday_hours_of_operation.closed_all_day

boolean

Flag to indicate whether the center is closed all day on Sundays.

body[].Sunday_hours_of_operation.opens

Time

Opening time on Sundays.

body[].Sunday_hours_of_operation.closes

Time

Closing time on Sundays.

body[].Monday_hours_of_operation

Object

Opening and closing time time on Mondays.

body[].Monday_hours_of_operation.closed_all_day

boolean

Flag to indicate whether the center is closed all day on Mondays.

body[].Monday_hours_of_operation.opens

Tiime

Opening time on Mondays.

body[].Monday_hours_of_operation.closes

Time

Closing time on Mondays.

body[].Tuesday_hours_of_operation

Object

Opening and closing time on Tuesdays.

body[].Tuesday_hours_of_operation.closed_all_day

boolean

Flag to indicate whether the center is closed all day on Tuesdays.

body[].Tuesday_hours_of_operation.opens

Time

Opening time on Tuesdays.

body[].Tuesday_hours_of_operation.closes

Time

Closing time on Tuesdays.

body[].Wednesday_hours_of_operation

Object

Opening and closing time on Wednesdays.

body[].Wednesday_hours_of_operation.closed_all_day

boolean

Flag to indicate whether the center is closed all day on Wednesdays.

body[].Wednesday_hours_of_operation.opens

Time

Opening time on Wednesdays.

body[].Wednesday_hours_of_operation.closes

Time

Closing time on Wednesdays.

body[].Thursday_hours_of_operation

Object

Opening and closing time on Thursdays.

body[].Thursday_hours_of_operation.closed_all_day

boolean

Flag to indicate whether the center is closed all day on Thursdays.

body[].Thursday_hours_of_operation.opens

Time

Opening time on Thursdays.

body[].Thursday_hours_of_operation.closes

Time

Closing time on Thursdays.

body[].Friday_hours_of_operation

Object

Opening and closing time on Fridays.

body[].Friday_hours_of_operation.closed_all_day

boolean

Flag to indicate whether the center is closed all day on Fridays.

body[].Friday_hours_of_operation.opens

Time

Opening time on Fridays.

body[].Friday_hours_of_operation.closes

Time

Closing time on Fridays.

body[].Saturday_hours_of_operation

Object

Opening and closing time on Saturdays.

body[].Saturday_hours_of_operation.closed_all_day

boolean

Flag to indicate whether the center is closed all day on Saturdays.

body[].Saturday_hours_of_operation.opens

Time

Opening time on Saturdays.

body[].Saturday_hours_of_operation.closes

Time

Closing time on Saturdays.

Accept

application/json

Content-Type

application/json

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].skill_id

int

The ID of the skill.

body[].skill_title

String

The title of the skill.

body[].skill_description

String

The description of the skill.

body[].available_for

String

Entities to which this skill applies.

Accept

application/json

Content-Type

application/json

page_info

In the HTTP request header, you can include page_info and specify required pagination or sorting parameters. Note that for this API, you can specify a number up to 500 for the total_records_per_page parameter.

facility_id

int

Mandatory

The facility id of the facility.

start_date

The start date of skip dates. Order option: ascending or descending.

start_time

The start time of skip dates. Order option: ascending or descending.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].skip_date_description

String

Description of the skip dates.

body[].skip_every_year

boolean

Whether the skip dates are effective every year.

body[].date_from

Date

The start date of the skip dates.

body[].time_from

Date

The start time of the skip dates.

body[].date_to

Date

The end date of the skip dates.

body[].time_to

Date

The end time of the skip dates.

Accept

application/json

Content-Type

application/json

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].season_id

int

The ID of the season.

body[].season_name

String

The name of the parent season.

body[].child_season[].child_season_id

int

ID of the activity’s child season.

body[].child_season[].child_season

String

Child season of the activity.

body[].child_season[].start_date

Date

Start date of the child season.

body[].child_season[].end_date

Date

End date of the child season.

body[].child_season[].prevent_further_use

boolean

Prevent future use flag for the child season.

body[].child_season[].first_date_in_person

Datetime

The default first registration date for in-person registrations for the child season.

body[].child_season[].first_date_in_person_non_residents

Datetime

The default first registration date for in-person registrations for non-residents for the child season.

body[].child_season[].first_date_in_person_members

Datetime

The default first registration date for in-person registrations for members for the child season.

body[].child_season[].last_date_in_person

Datetime

The default last registration date for in-person registrations for the child season.

body[].child_season[].first_date_on_internet

Datetime

The default first registration date for online registrations for the child season.

body[].child_season[].first_date_on_internet_non_residents

Datetime

The default first registration date for online registrations for non-residents for the child season.

body[].child_season[].first_date_on_internet_members

Datetime

The default first registration date for online registrations for members for the child season.

body[].child_season[].last_date_on_internet

Datetime

The default last registration date for online registrations for the child season.

body[].start_date

Date

The start date of the season.

body[].end_date

Date

The end date of the season.

body[].site_id

int

The ID of the site.

body[].prevent_further_use

boolean

Prevent future use flag.

body[].first_date_in_person

Datetime

The default first registration date for in-person registrations for the parent season.

body[].first_date_in_person_non_residents

Datetime

The default first registration date for in-person registrations for non-residents for the parent season.

body[].first_date_in_person_members

Datetime

The default first registration date for in-person registrations for members for the parent season.

body[].last_date_in_person

Datetime

The default last registration date for in-person registrations for the parent season.

body[].first_date_on_internet

Datetime

The default first registration date for online registrations for the parent season.

body[].first_date_on_internet_non_residents

Datetime

The default first registration date for online registrations for non-residents for the parent season.

body[].first_date_on_internet_members

Datetime

The default first registration date for online registrations for members for the parent season.

body[].last_date_on_internet

Datetime

The default last registration date for online registrations for the parent season.

Accept

application/json

Content-Type

application/json

page_info

In the HTTP request header, you can include page_info and specify required pagination or sorting parameters. Note that for this API, you can specify a number up to 500 for the total_records_per_page parameter.

activity_name

String

Optional

Activity name. All activities whose names fully or partially match the specified name are returned.

activity_number

String

Optional

Activity number. All activities whose activity numbers fully or partially match the specified activity number are returned.

activity_type_id

int

Optional

The ID of the activity type.

parent_season_id

int

Optional

The ID of the activity parent season.

activity_status_id

int

Optional

You can only specify one activity status: 0-Open, 1-Closed, 2-Cancelled, 3-Tentative, 4-On Hold, 5-Retired, 6-Date Conflicted

category_id

int

Optional

The ID of the activity category.

other_category_id

int

Optional

The ID of the activity other category.

site_ids

String

Optional

The IDs of the sites assigned to the activity. You can specify up to 5 sites, with each site separated by a comma.

center_ids

String

Optional

The center ID for the activity’s facilities. You can specify up to 5 centers, with each center separated by a comma.

days_of_week

String

Optional

If a meeting date is within the specified days of the week, then the activity is returned. (e.g. If the days of the week are Mon and Wed, the specified string should be 0101000)

first_date_range_from

YYYY-MM-DD

Optional

Activities whose first meeting date is on or after the specified date are returned.

first_date_range_to

YYYY-MM-DD

Optional

Activities whose first meeting date is on or before the specified date are returned.

last_date_range_from

YYYY-MM-DD

Optional

Activities whose last meeting date is on or after the specified date are returned.

last_date_range_to

YYYY-MM-DD

Optional

Activities whose last meeting date is on or before the specified date are returned.

modified_date_from

YYYY-MM-DD HH:MM

Optional

Activities last updated on or after the specified date and time are returned (HH:MM is optional).

modified_date_to

YYYY-MM-DD HH:MM

Optional

Activities last updated on or before the specified date and time are returned (HH:MM is optional).

gender

int

Optional

Genders eligible for registration. (0-Mixed, 1-Male, 2-Female, 13-Non-binary, 14-Prefer not to say. Organizations that have configured gender options can retrieve these gender options and their corresponding IDs through the GetGenders API).

age_from

int

Optional

Activities whose age ranges are fully or partially within the specified age range are returned.

age_to

int

Optional

Activities whose age ranges are fully or partially within the specified age range are returned.

skill_id

int

Optional

The ID of the skill. Activities whose configured skills include the skill specified are returned. Call GetSkills API to get the skill_id.

show_on_member_app

String

Optional

Filter for activities by their 'Show On The ACTIVE Net Captivate App' flag: Y or N

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].activity_name

String

The name of the activity.

body[].activity_number

String

The number of the activity.

body[].activity_id

int

The ID of the activity.

body[].modified_date_time

String

The last date and time when the activity was modified.

body[].activity_type_id

int

ID of the activity type.

body[].activity_type

String

The activity type of the activity.

body[].parent_season_id

int

ID of the activity’s parent season.

body[].parent_season

String

The parent season of the activity.

body[].child_season_id

int

ID of the activity’s child season.

body[].child_season

String

The child season (i.e. term) of the activity.

body[].activity_status_id

int

ID of the activity status: 0-Open, 1-Closed, 2-Cancelled, 3-Tentative, 4-On Hold, 5-Retired, 6-Date Conflicted.

body[].activity_status

String

The status of the activity.

body[].activity_department_id

int

ID of the activity department.

body[].activity_department

String

The department of the activity.

body[].category_id

int

ID of the activity category.

body[].category

String

The category of the activity.

body[].other_category_id

int

ID of the activity other category.

body[].other_category

String

The other category of the activity.

body[].site_id

int

The activity’s site ID.

body[].site_name

String

The site of the activity.

body[].default_facilities

String

The name of the facilities that are reserved for the activity’s default pattern.

body[].default_beginning_date

Date

The first meeting date of the activity default pattern.

body[].default_ending_date

Date

The last meeting date of the activity default pattern.

body[].default_pattern_dates

String

The days of the week, start time, and duration of the activity default pattern.

body[].gender_id

int

Eligible genders for registration: 0-Mixed, 1-Male, 2-Female, 13-Non-binary, 14-Prefer not to say. Organizations that have configured gender options can retrieve these gender options and their corresponding IDs through the GetGenders API.

body[].gender

String

Genders eligible for registration

body[].age_min_year

int

Minimum participant age (year) configured for the activity.

body[].age_min_month

int

Minimum participant age (month) configured for the activity.

body[].age_min_week

int

Minimum participant age (week) configured for the activity.

body[].age_max_year

int

Maximum participant age (year) configured for the activity.

body[].age_max_month

int

Maximum participant age (month) configured for the activity.

body[].age_max_week

int

Maximum participant age (week) configured for the activity.

body[].enroll_min

int

The minimum number of participants for the activity.

body[].enroll_max

int

The maximum number of participants for the activity.

body[].show_on_member_app

String

Whether the activity is displayed on the ACTIVE Net Captivate App: 'Y' or 'N'.

Accept

application/json

Content-Type

application/json

activityId

int

Mandatory

activity ID.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].activity_name

String

The name of the activity.

body[].activity_number

String

The number of the activity.

body[].external_event_number

String

The external number of the activity.

body[].activity_id

int

The activity ID.

body[].asset_id

String

The asset ID of the activity.

body[].public_url

String

The public URL in the CUI where customers can register for the activity.

body[].activity_type_id

int

ID of the activity type.

body[].activity_type

String

The activity type of the activity.

body[].parent_season_id

int

ID of the activity’s parent season.

body[].parent_season

String

The parent season of the activity.

body[].child_season_id

int

ID of the activity’s child season.

body[].child_season

String

The child season of the activity.

body[].activity_status_id

int

ID of the activity status: 0-Open, 1-Closed, 2-Cancelled, 3-Tentative, 4-On Hold, 5-Retired, 6-Date Conflicted.

body[].activity_status

String

The status of the activity.

body[].activity_department_id

int

ID of the activity department.

body[].activity_department

String

The department of the activity.

body[].category_id

int

ID of the activity category.

body[].category

String

The category of the activity.

body[].other_category_id

int

ID of the activity other category.

body[].other_category

String

The other category of the activity.

body[].catalog_description

String

The catalog description of the activity.

body[].tax_receipt_eligibility

boolean

The tax receipt eligibility of the activity.

body[].usage_fee_name

String

The usage fee name of the activity.

body[].site_name

String

The site of the activity.

body[].site_id

int

The site ID of the activity’s site.

body[].location_description

String

The location description of the activity.

body[].default_beginning_date

Date

The first meeting date of the activity default pattern.

body[].default_ending_date

Date

The last meeting date of the activity default pattern.

body[].date_description

String

The date description of the activity.

body[].activity_patterns[].pattern_facilities[].facility_name

String

The facility name of the facility that is reserved for the activity.

body[].activity_patterns[].pattern_facilities[].facility_id

int

The ID of the facility that is reserved for the activity.

body[].activity_patterns[].pattern_facilities[].center_name

String

The center name of the facility that is reserved for the activity.

body[].activity_patterns[].pattern_facilities[].center_id

int

The center ID of the facility that is reserved for the activity.

body[].activity_patterns[].pattern_name

String

The name of the activity pattern.

body[].activity_patterns[].event_notes

String

The event notes of the activity pattern.

body[].activity_patterns[].beginning_date

String

The first meeting date of the activity pattern.

body[].activity_patterns[].ending_date

String

The last meeting date of the activity pattern.

body[].activity_patterns[].weeks_of_month

String

The weeks of the month configured in the activity pattern.

body[].activity_patterns[].pattern_dates[].pattern_date

String

The days of the week, start time, and duration of the activity pattern.

body[].activity_patterns[].preparation_code.preparation_code_name

String

The name of the prep code that is applied to the activity pattern.

body[].activity_patterns[].preparation_code.setup_time

int

The setup time of the prep code that is applied to the activity pattern.

body[].activity_patterns[].preparation_code.cleanup_time

int

The cleanup time of the prep code that is applied to the activity pattern.

body[].number_of_meeting_dates

int

The number of meeting dates in the activity.

body[].number_of_weeks

int

The number of calendar weeks in which the activity occurs.

body[].number_of_enrolled

int

The number of enrollments in the activity.

body[].open_spaces

String

The number of openings in the activity.

body[].open_spaces_online

String

The number of openings of the activity for online registration.

body[].gender_id

int

Eligible genders for registration: 0-Mixed, 1-Male, 2-Female, 13-Non-binary, 14-Prefer not to say. Organizations that have configured gender options can retrieve these gender options and their corresponding IDs through the GetGenders API.

body[].gender

String

Genders eligible for registration.

body[].age_max_year

Integer

Maximum participant age (year) of the activity.

body[].age_max_month

Integer

Maximum participant age (month) of the activity.

body[].age_max_week

Integer

Maximum participant age (week) of the activity.

body[].age_min_year

int

Minimum participant age (year) of the activity.

body[].age_min_month

int

Minimum participant age (month) of the activity.

body[].age_min_week

int

Minimum participant age (week) of the activity.

body[].min_grade

String

Minimum participant grade of the activity.

body[].max_grade

String

Maximum participant grade of the activity.

body[].age_calc_date

String

The calculation date of the participants' age.

body[].alternate_key_type

String

The required alternate key type of the participant.

body[].alternate_key_status

String

The required alternate key status of the participant.

body[].enroll_min

int

The minimum number of participants that must be enrolled in the activity.

body[].enroll_max

Integer

The maximum number of participants for the activity. Return null if unlimited.

body[].priority_enrollment_datetimes.first_daytime_person

String

The first available registration date/time for in-person registration in the priority registration window.

body[].priority_enrollment_datetimes.first_daytime_person_nonresidents

String

The first available registration date/time for in-person registration for non-residents in the priority registration window.

body[].priority_enrollment_datetimes.first_daytime_members

String

The first available registration date/time for in-person registration for members in the priority registration window.

body[].priority_enrollment_datetimes.last_daytime_person

String

The last available registration date/time for in-person registration in the priority registration window.

body[].priority_enrollment_datetimes.first_daytime_internet

String

The first available registration date/time for online registration in the priority registration window.

body[].priority_enrollment_datetimes.first_daytime_internet_nonresidents

String

The first available registration date/time for online registration for non-residents in the priority registration window.

body[].priority_enrollment_datetimes.first_daytime_internet_members

String

The first available registration date/time for online registration in the priority registration window.

body[].priority_enrollment_datetimes.last_daytime_internet

String

The last available registration date/time for online registration in the priority registration window.

body[].enrollment_datetimes[].first_daytime_person

String

The first available registration date/time for in-person registration.

body[].enrollment_datetimes[].first_daytime_person_nonresidents

String

The first available registration date/time for in-person registration for non-residents.

body[].enrollment_datetimes[].first_daytime_members

String

The first available registration date/time for in-person registration for members.

body[].enrollment_datetimes[].last_daytime_person

String

The last available registration date/time for in-person registration.

body[].enrollment_datetimes[].first_daytime_internet

String

The first available registration date/time for online registration.

body[].enrollment_datetimes[].first_daytime_internet_nonresidents

String

The first available registration date/time for online registration for non-residents.

body[].enrollment_datetimes[].first_daytime_internet_members

String

The first available registration date/time for online registration.

body[].enrollment_datetimes[].last_daytime_internet

String

The last available registration date/time for online registrations.

body[].user_notes

String

The staff user notes of the activity.

body[].online_notes

String

The online notes of the activity.

body[].receipt_notes

String

The receipt notes of the activity.

body[].no_internet_reg

boolean

No internet registration flag.

body[].hide_on_internet

boolean

Hide on internet flag.

body[].no_qty_based_enrollment

boolean

No quantity based enrollment flag.

body[].use_pass_or_fail

boolean

Use pass or fail flag.

body[].show_price_info_online

boolean

Show price online flag.

body[].show_scholarship_online

boolean

Show scholarship online flag.

body[].allow_waiting_list

boolean

Allow waiting list flag.

body[].online_new_activity

boolean

The activity is displayed as a new activity or not in the CUI.

body[].online_new_until

String

The activity is displayed as a new activity in the CUI until the specified date.

body[].instructors

String

The full name of the instructor. Format: First name Last name. Multiple instructors are separated by comma. (e.g.: John Smith, John Brian)

body[].supervisor

String

The name of the activity supervisor. Format: First name Last name.

body[].skills[].skill_id

int

The ID of the skill.

body[].skills[].skill_title

String

The title of the skill.

body[].allow_private_lesson_bookings

boolean

Private lesson activity flag.

body[].parent_activity_name

String

The activity name of the parent activity.

body[].parent_activity_number

String

The activity number of the parent activity.

body[].top_parent_activity_name

String

The activity name of the top parent activity.

body[].top_parent_activity_number

String

The activity number of the top parent activity.

body[].sub_activity_number

String

The activity number of the sub-activities. Multiple sub-activities are separated by commas (e.g. 1212.112, 1212.223, 1123.909).

body[].organization.guid

String

Organization GUID.

body[].organization.name

String

Organization name.

body[].organization.url

String

Organization’s website.

body[].organization.address1

String

The first line address of the organization.

body[].organization.address2

String

The second line address of the organization.

body[].organization.city

String

City of the organization.

body[].organization.state

String

State for the organization.

body[].organization.zip

String

Zip code of the organization.

body[].organization.fax

String

Fax number of the organization.

body[].organization.email

String

Email address of the organization.

body[].organization.phone

String

Phone number of the organization.

body[].activity_recurrences[].activity_start_date

String

Start date of the activity meeting dates pattern.

body[].activity_recurrences[].activity_start_time

String

Start time of the activity meeting dates pattern.

body[].activity_recurrences[].activity_end_date

String

End date of the activity meeting dates pattern.

body[].activity_recurrences[].activity_end_time

String

End time of the activity meeting dates pattern.

body[].activity_recurrences[].frequency

String

Frequency of the activity meeting dates.

body[].activity_recurrences[].days

String

Days of the week of the activity meeting dates pattern.

body[].activity_recurrences[].activityExclusions[].exclusion_start_date

String

Start date of the dates that are excluded from the pattern.

body[].activity_recurrences[].activityExclusions[].exclusion_end_date

String

End date of the dates that are excluded from the pattern.

body[].place.name

String

The name of the facility/center/site.

body[].place.address1

String

The first line address of the facility/center/site.

body[].place.address2

String

The second line address of the facility/center/site.

body[].place.city

String

The city of the facility/center/site.

body[].place.state

String

The state for the facility/center/site.

body[].place.zip

String

The zip code of the facility/center/site.

body[].place.country

String

The country of the facility/center/site.

body[].show_on_member_app

String

Whether the activity is displayed on the ACTIVE Net Captivate App, 'Y' or 'N'.

body[].prerequisites_membership

Array

The programs current membership in settings in prerequisites.

body[].prerequisites_membership[].prerequisite_id

int

The id of current prerequisite.

body[].prerequisites_membership[].group_number

int

The group id of the current membership.

body[].prerequisites_membership[].package_id

int

Package IDs of the memberships configured in the ‘Current Membership in’ settings.

body[].prerequisites_membership[].package_name

String

Package names of the memberships configured in the ‘Current Membership in’ settings.

body[].allow_dropin

String

Whether the activity allows drop-in reservations: 'Y' or 'N'.

body[].dropin_fee_charge_amount

BigDecimal

The charge amount for the drop-in reservation fee.

Accept

application/json

Content-Type

application/json

show_on_member_app

String

Optional

Filter for activity categories by their 'Show On The ACTIVE Net Captivate App' flag: Y or N.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].category_id

int

The ID of the activity category.

body[].activity_category_name

String

The name of the activity category.

body[].link_interest_list

boolean

Link interest list flag.

body[].hide_on_internet

boolean

Hide on internet flag.

body[].show_on_member_app

String

Whether activities with this activity category are displayed on the ACTIVE Net Captivate app.

Accept

application/json

Content-Type

application/json

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].other_category_id

int

The ID of the activity other category.

body[].other_category_name

String

The name of the activity other category.

body[].link_interest_list

boolean

Link interest list flag.

body[].hide_on_internet

boolean

Hide on internet flag.

Accept

application/json

Content-Type

application/json

activity_id

int

Mandatory

The ID of the activity.

Content-Type

application/json

headers

object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

array

The body object in the response body.

body[].normal_charges

Array

Normal Charges/Discount.

body[].normal_charges[].charge_name

String

The charge name of the activity fee/discount/scholarship.

body[].normal_charges[].charge_type

String

The charge type of the activity fee/discount/scholarship.

body[].normal_charges[].discount_order

int

The order that a discount shall be applied.

body[].normal_charges[].prefill_condition

String

The prefill condition of the activity fee/discount/scholarship.

body[].normal_charges[].primary_fee

boolean

The primary fee flag for the activity fee.

body[].normal_charges[].default_amount

BigDecimal

The default amount of the activity fee/discount/scholarship.

body[].normal_charges[].default_percentage

BigDecimal

The default percentage of the activity discount/scholarship.

body[].normal_charges[].customer_type

String

The customer type that qualifies for the activity fee/discount/scholarship.

body[].normal_charges[].description

String

The description of the activity fee/discount/scholarship.

body[].normal_charges[].regional_pricings

Array

Regional pricing array.

body[].normal_charges[].regional_pricings[].country

String

Regional pricing country.

body[].normal_charges[].regional_pricings[].states

String

Regional pricing states.

body[].normal_charges[].regional_pricings[].charge_amount

BigDecimal

The charge amount of the regional pricing

body[].normal_charges[].gl_accounts

Array

The GL account information of the fee, discount, or scholarship.

body[].normal_charges[].gl_accounts[].gl_account_name

String

G/L account name.

body[].normal_charges[].gl_accounts[].gl_account_number

String

G/L account number.

body[].normal_charges[].scheduled_fees

Array

The scheduled fee change configured for this fee.

body[].normal_charges[].scheduled_fees[].effective_date

Date

Effective date.

body[].normal_charges[].scheduled_fees[].charge_amount

BigDecimal

Charge amount.

body[].normal_charges[].activation_date

Date

The activation date of the fee, discount or scholarship.

body[].normal_charges[].expiration_date

Date

The expiration date of the fee, discount or scholarship.

body[].global_discounts

Array

Global discounts.

body[].global_discounts[].global_discount_name

String

The name of the applicable global discount.

body[].global_discounts[].global_discount_order

int

The order of the applicable global discount.

body[].global_discounts[].global_discount_group_number

int

The group number of the applicable global discount.

body[].global_discounts[].global_discount_amount

BigDecimal

The amount/percent of the applicable global discount. (e.g. 10.20 means $10.20).

body[].global_discounts[].global_discount_percent

BigDecimal

The amount/percent of the applicable global discount. (e.g. 10.20 means 10.20%).

body[].global_discounts[].global_discount_retired

boolean

Is the global discount retired?

body[].global_surcharges

Array

Global surcharges.

body[].global_surcharges[].global_surcharge_name

String

The name of the applicable global surcharge.

body[].global_surcharges[].global_surcharge_amount

BigDecimal

The amount of the applicable global surcharge. (e.g. 10.20 means $10.20).

body[].global_surcharges[].global_surcharge_percent

BigDecimal

The percent of the applicable global surcharge. (e.g. 10.20 means 10.20%).

body[].global_surcharges[].global_surcharge_retired

boolean

Is the global surcharge retired? (true, false)

Accept

application/json

Content-Type

application/json

show_on_member_app

String

Optional

Filter for activity categories by their 'Show On The ACTIVE Net Captivate App' flag: Y or N.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].activity_type_name

String

The name of the activity type.

body[].activity_type_id

int

The ID of the activity type.

body[].prevent_further_use

boolean

Prevent future use flag.

body[].show_on_member_app

String

Whether activities with this activity type are displayed on the ACTIVE Net Captivate app.

Accept

application/json

Content-Type

application/json

page_info

In the HTTP request header, you can include page_info and specify required pagination or sorting parameters. Note that for this API, you can specify a number up to 500 for the total_records_per_page parameter.

activity_id

int

Optional if customer_ids is specified, otherwise required.

The ID number of the required activity. Returns all customers enrolled in the specified activity.

customer_ids

String

Optional if activity_id is specified, otherwise required.

The ID numbers of the required customers (up to 100 comma-separated customer IDs can be specified). Returns enrollments for all specified customers.

enrollment_status

int

Optional

You can specify one enrollment status to search customer enrollment information: 1-Enrolled, 2-Withdrawn, 3- Waitlisted, 4 - Waitlist Removed, 5-Trial, 6-All. Default value is 1.

date_after

YYYY-MM-DD HH:MM

Optional

Customers who enrolled, withdrawn, waitlisted, waitlist removed, enrolled trail class on or after this specified date and time are returned (HH:MM is optional).

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].activity_id

int

ID of the activity.

body[].activity_name

String

Name of the activity.

body[].enrollment_status

String

The enrollment status of the customer in the activity: 'Enrolled', 'Withdrawn', 'Waitlisted', 'Waitlist Removed' or 'Trial'.

body[].first_name

String

First name of the customer.

body[].last_name

String

Last name of the customer.

body[].customer_id

int

ID of the customer.

body[].customer_date_modified

Datetime

The most recent date and time when the customer information was modified.

body[].customer_email

String

Email address of the customer.

body[].receipt_number

BigDecimal

Receipt number of the last transaction.

body[].has_active_membership

boolean

Whether the customer has an active membership.

body[].trial_class_date

Datetime

The meeting date the customer selected when doing trial class enrollment.

body[].last_transaction_date

Datetime

Date of the customer’s last transaction.

body[].withdraw_date

Datetime

The date and time when the customer withdrew from the activity.

body[].total_fee

BigDecimal

The total fee for the activity.

body[].total_paid

BigDecimal

The total amount paid for the activity.

body[].total_due

BigDecimal

The total due amount for the activity.

body[].date_registered

Datetime

The date and time the customer enrolled for the activity.

body[].waitlisted_date

Datetime

The date the customer was added to waitlist.

body[].waitlist_removed_date

Datetime

The date the customer was removed from waitlist.

body[].quantity

int

The number of seats enrolled by the customer.

body[].payers

Array

Payers of the enrollment.

body[].payers[].payer_first_name

String

First name of the payer. Only displays when the payer is an individual customer.

body[].payers[].payer_last_name

String

Last name of the payer. Only displays when the payer is an individual customer.

body[].payers[].payer_customer_id

int

Customer ID of the payer. Only displays when the payer is an individual customer.

body[].payers[].payer_email

String

Email address of the payer. Only displays when the payer is an individual customer.

body[].payers[].payer_company_name

String

Name of the company. Only displays when the payer is a company.

body[].payers[].payer_company_phone

String

Phone 1 of the company. Only displays when the payer is a company.

Accept

application/json

Content-Type

application/json

page_info

In the HTTP request header, you can include page_info and specify required pagination or sorting parameters. Note that for this API, you can specify a number up to 500 for the total_records_per_page parameter.

activity_ids

int

Mandatory

The IDs of the activity.

enrollment_status

int

Optional

You can specify one enrollment status to search customer enrollment information: 1-Enrolled, 2-Withdrawn, 3- Waitlisted, 4 - Waitlist Removed, 5-Trial, 6-All. Default value is 1.

date_after

YYYY-MM-DD HH:MM

Optional

Customers who enrolled, withdrawn, waitlisted, waitlist removed, enrolled trial class on or after this specified date and time are returned (HH:MM is optional).

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].activity_id

int

The ID of the activity.

body[].activity_name

String

The name of the activity.

body[].activity_status

String

The status of the activity.

body[].activity_category

String

The category of the activity.

body[].activity_other_category

String

The other category of the activity.

body[].activity_patterns[].pattern_name

String

The name of the activity pattern.

body[].activity_patterns[].beginning_date

String

The first meeting date of the activity pattern.

body[].activity_patterns[].ending_date

String

The last meeting date of the activity pattern.

body[].activity_patterns[].weeks_of_month

String

The weeks of the month configured in the activity pattern.

body[].activity_patterns[].pattern_dates[].pattern_date

String

The days of the week, start time, and duration of the activity pattern.

body[].first_name

String

First name of the customer.

body[].last_name

String

Last name of the customer.

body[].customer_id

int

ID of the customer.

body[].customer_email

String

Email address of the customer.

body[].trial_class_date

Datetime

The meeting date the customer selected when doing trial class enrollment.

body[].enrollment_status

String

The enrollment status of the customer in the activity: 'Enrolled', 'Withdrawn', 'Waitlisted' or 'Waitlist Removed' or 'Trial'.

body[].date_registered

Datetime

The date and time the customer enrolled for the activity.

body[].has_active_membership

boolean

Whether the customer has an active membership.

body[].home_phone

String

The home phone number of the customer.

body[].work_phone

String

The work phone number of the customer.

body[].cell_phone

String

The cell phone number of the customer.

body[].mobile_carrier

String

The mobile carrier of the customer’s cell phone.

body[].age

String

Age of the customer.

body[].age_category

String

Age category of the customer.

body[].gender

String

Gender of the customer.

body[].residential_address1

String

The first line of the customer’s residential address.

body[].residential_address2

String

The second line of the customer’s residential address.

body[].residential_city

String

The city of the customer’s residential address.

body[].residential_state_or_province

String

The state/province of the customer’s residential address.

body[].residential_zip_code

String

The zip code of the customer’s residential address.

body[].families[].family_id

int

Family ID.

body[].families[].head_of_household

String

Head of household of this family.

body[].families[].head_of_household_customer_id

Integer

Customer ID of the head of household.

body[].families[].head_of_household_customer_first_name

String

First name of the head of the household.

body[].families[].head_of_household_customer_last_name

String

Last name of the head of the household.

body[].families[].head_of_household_customer_email

String

Email of the head of the household.

body[].payers

Array

Payers of the enrollment.

body[].payers[].payer_first_name

String

First name of the payer. Only displays when the payer is an individual customer.

body[].payers[].payer_last_name

String

Last name of the payer. Only displays when the payer is an individual customer.

body[].payers[].payer_customer_id

int

Customer ID of the payer. Only displays when the payer is an individual customer.

body[].payers[].payer_email

String

Email address of the payer. Only displays when the payer is an individual customer.

body[].payers[].payer_company_name

String

Name of the company. Only displays when the payer is a company.

body[].payers[].payer_company_phone

String

Phone 1 of the company. Only displays when the payer is a company.

body[].question_answers[].question_title

String

The title of the custom question.

body[].question_answers[].question_text

String

The question text which will be displayed during a transaction.

body[].question_answers[].question_id

int

ID of the custom question.

body[].question_answers[].answer

String

The answer of custom question. Multiple answers are separated by commas

body[].question_answers[].time_stamp

Datetime

The date and time when the customer answered the question.

Accept

application/json

Content-Type

application/json

activity_id

int

Mandatory

The id of the activity.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].activity_id

int

The activity ID..

body[].activity_date_id

int

The date ID of this activity date.

body[].activity_facility_id

int

The facility ID of the facility reserved on this activity date.

body[].activity_facility_name

String

The facility name of the facility reserved onthis activity date.

body[].activity_center_id

int

The center ID of the facility reserved on this activity date.

body[].activity_center_name

String

The center name of the facility reserved on this activity date.

body[].start_date_time

Datetime

The start date and time of the activity for this activity date.

body[].end_date_time

Datetime

The end date and time of the activity for this activity date.

body[].available_spots

Datetime

Available spots on this activity date. It is blank if available spots are unlimited.

Accept

application/json

Content-Type

application/json

page_info

In the HTTP request header, you can include page_info and specify required pagination or sorting parameters. Note that for this API, you can specify a number up to 500 for the total_records_per_page parameter.

customer_id

int

Optional

The ID of the customer.

site_ids

String

Optional

The ID of site assigned to the customer. You can specify up to 5 sites, with each site separated by a comma.

gender

int

Optional

Customer gender. (0-Mixed, 1-Male, 2-Female, 13-Non-binary, 14-Prefer not to say. Organizations that have configured gender options can retrieve these gender options and their corresponding IDs through the GetGenders API).

first_name

String

Optional

First name of the customer. All customers whose first names start with the specified first name are returned.

last_name

String

Optional

Last name of the customer. All customers whose last names start with the specified last name are returned.

min_age

int

Optional

Customers whose age are older than or equal to the specified minimum participant age are returned.

max_age

int

Optional

Customers whose age are younger than or equal to the specified maximum participant age are returned.

modified_date_from

YYYY-MM-DD HH:MM

Optional if activity_id, customer_ids or alternate_key_ids are specified or prospect = true, otherwise required.

Return a list of customers whose information was last modified on or after the specified date and time (HH:MM is optional).

activity_id

int

Optional if customer_ids, alternate_key_ids or modified_date_from are specified or prospect = true, otherwise required.

The ID of the activity. Customers who enrolled in the specified activity are returned.

customer_ids

int

Optional if activity_id, alternate_key_ids or modified_date_from are specified or prospect = true, otherwise required.

You can specify up to 500 customer IDs, with each customer ID separated by a comma.

alternate_key_ids

String

Optional if activity_id, customer_ids or modified_date_from are specified or prospect = true, otherwise required.

The alternate key IDs of the customers. You can specify up to 100 alternate key IDs, with each ID separated by a comma.

prospect

Boolean

Optional if activity_id, customer_ids, alternate_key_ids or modified_date_from are specified, otherwise required.

You can specify boolean value to only search prospect or non-prospect customers.

birth_date

Date

Optional

Customer’s date of birth (YYYY-MM-DD)

residential_zip_code

String

Optional

Customer’s residential postal code. If the first three digits are provided, this API can be used to perform a fuzzy search. However, if all the digits are provided, this API can only be used for an exact search.

residential_address1

String

Optional

The first line of the customer’s residential address. You can enter part of an address to perform a fuzzy search. Note that this parameter is case insensitive.

email

String

Optional

The email address of the customer.

home_phone

String

Optional

The home phone number of the customer (excluding the country code) A minimum of six digits is required for a home phone number search.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].customer_id

int

The ID of the customer.

body[].encrypted_customer_id

String

The encrypted ID of the customer.

body[].customer_title

String

The title of the customer.

body[].first_name

String

The first name of the customer.

body[].middle_name

String

The middle name of the customer.

body[].last_name

String

The last name of the customer.

body[].legal_name

String

The legal name of the customer.

body[].customer_type

String

The customer type of the customer.

body[].geographic_area

String

The geographic area of the customer.

body[].residential_address1

String

The first line of the customer’s residential address.

body[].residential_address2

String

The second line of the customer’s residential address.

body[].residential_city

String

The city of the customer’s residential address.

body[].residential_state_or_province

String

The state/province of the customer’s residential address.

body[].residential_zip_code

String

The zip code of the customer’s residential address.

body[].mailing_address1

String

The first line of the customer’s mailing address.

body[].mailing_address2

String

The second line of the customer’s mailing address.

body[].mailing_city

String

The city of the customer’s mailing address.

body[].mailing_state_or_province

String

The state/province of the customer’s mailing address.

body[].mailing_zip_code

String

The zip code of the customer’s mailing address.

body[].mailing_name

String

The customer’s mailing name that used on mail-outs and statements.

body[].occupation

String

The customer’s occupation description.

body[].home_phone

String

The home phone number of the customer.

body[].work_phone

String

The work phone number of the customer.

body[].cell_phone

String

The cell phone number of the customer.

body[].mobile_carrier

String

The mobile carrier of the customer’s cell phone.

body[].fax_phone

String

The fax number of the customer.

body[].pager_phone

String

The pager phone number of the customer.

body[].other_phone

String

The other phone number of the customer.

body[].email

String

The email address of the customer.

body[].guardian_email

String

The guardian email address of the customer which age under 13.

body[].guardian_contact_id

int

The guardian customer ID.

body[].additional_email

String

The additional email address of the customer.

body[].birth_date

Date

Customer’s date of birth.

body[].age_category

String

Age category of the customer.

body[].gender

String

Gender of the customer.

body[].grade

String

The school grade of the customer.

body[].age

String

Age of the customer.

body[].resident_status

String

Customer’s resident status.

body[].residency_expire_date

Date

Customer’s residency expiration date.

body[].retired_status

String

Customer’s retirement status.

body[].special_handling

boolean

Whether the customer needs special handling.

body[].head_of_household

boolean

Whether the customer is the head of household.

body[].families[].family_id

int

Family ID.

body[].families[].household_size

int

The number of persons in the household of this family.

body[].families[].head_of_household

String

Head of household of this family.

body[].families[].head_of_household_customer_id

Integer

Customer ID of the head of household.

body[].families[].head_of_household_customer_first_name

String

First name of the head of the household.

body[].families[].head_of_household_customer_last_name

String

Last name of the head of the household.

body[].families[].head_of_household_customer_email

String

Email of the head of the household.

body[].families[].external_id

int

Family external ID.

body[].families[].family_role

String

Family role.

body[].has_active_membership

boolean

Whether the customer has an active membership.

body[].alternate_keys[].alternate_key_type

String

Alternate key type.

body[].alternate_keys[].alternate_key_status

String

Alternate key status.

body[].alternate_keys[].alternate_key_id

String

Alternate key ID.

body[].emergency_contact1_first_name

String

The first name of the customer’s first emergency contact.

body[].emergency_contact1_last_name

String

The last name of the customer’s first emergency contact.

body[].emergency_contact1_phone

String

The phone number of the customer’s first emergency contact.

body[].emergency_contact1_relation

String

The relationship between the customer and his/her first emergency contact.

body[].emergency_contact1_other_phone

String

The other phone number of the customer’s first emergency contact.

body[].emergency_contact2_first_name

String

The first name of the customer’s second emergency contact.

body[].emergency_contact2_last_name

String

The last name of the customer’s second emergency contact.

body[].emergency_contact2_phone

String

The phone number of the customer’s second emergency contact.

body[].emergency_contact2_relation

String

The relationship between the customer and his/her second emergency contact.

body[].emergency_contact2_other_phone

String

The other phone number of the customer’s second emergency contact.

body[].no_mail

boolean

Whether the customer agree on receiving promotional emails.

body[].date_time_modified

datetime

The most recent date and time when the customer information was modified. Format 'YYYY-MM-DD HH:MM:SS' (example: 2016-06-11 23:00:00)

body[].customer_notes

String

Customer notes.

body[].customer_medical_alert

String

Customer medical alert.

body[].customer_general_alert

String

Customer general alert (staff use only).

body[].no_postal_mail

boolean

Whether the customer agree to receive postal mails.

body[].not_online_activated

boolean

Whether the customer is activated in the CUI.

body[].login_created

Date

The customer’s CUI account creation time.

body[].login_used

Date

The customer’s most recent login time in the CUI.

body[].interest_date

Date

The date when the customer’s interest charge is generated.

body[].country

String

Country of the customer.

body[].late_fee_date

Date

The date when the customer’s late fee is generated.

body[].agree_receive_text_message

boolean

Whether the customer agrees to receive text message.

body[].created_on

String

The customer account is created on the staff side or online.

body[].photo_key

String

The key to retrieve the required customer photo. Note that the photo_key is static for each customer. If the customer photo is updated in the AUI, the photo_key for the customer remains unchanged.

body[].skills[].skill_id

int

The ID of the skill.

body[].skills[].skill_title

String

The title of the skill.

body[].skills[].evaluation_date

Date

The evaluation date of the customer’s skill.

body[].skills[].evaluator

String

The system user’s name who evaluated customer’s skill.

body[].skills[].expiry_date

Date

The expiry date of the customer’s skill.

body[].skills[].evaluator_comment

String

The comment the system user left when evaluate the customer’s skill.

body[].last_transaction_date

Date

Date of the customer’s last transaction.

Accept

application/json

Content-Type

application/json

body

Array

Customer list to be added

body[].first_name

String

Customer’s first name.

body[].last_name

String

The last name of the customer.

body[].email

String

The email address of the customer.

body[].birth_date

Date

Customer’s date of birth.Format: yyyy-MM-dd

body[].middle_name

String

Middle Name of the Customer.

body[].SSN

String

Social Security number.

body[].mailing_address1

String

The first line of the customer’s mailing address.

body[].mailing_address2

String

The second line of the customer’s mailing address.

body[].mailing_city

String

The city of the customer’s mailing address.

body[].mailing_state_or_province_id

int

The state/province of the customer’s mailing address.

body[].mailing_zip_code

String

The zip code of the customer’s mailing address.

body[].mailing_name

String

The customer’s mailing name that used on mail-outs and statements.

body[].residential_address1

String

The first line of the customer’s residential address.

body[].residential_address2

String

The second line of the customer’s residential address.

body[].residential_city

String

The city of the customer’s residential address.

body[].residential_state_or_province_id

int

The state/province ID of the customer’s residential address.

body[].residential_zip_code

String

The zip code of the customer’s residential address.

body[].additional_email

String

The additional email address of the customer.

body[].gender_id

int

The gender ID of the customer.

body[].resident

Boolean

Customer’s resident status.

body[].head_of_household

Boolean

Whether the customer is the head of household. If it is ‘true’, the auto-created family under the new customer will assign the customer as the ‘head of household’; If it is ‘false’, the customer will not be assigned as the ‘head of household’.

body[].no_mail

Boolean

Whether the customer agree on receiving promotional emails. false means to agree to receive promotional emails.

body[].no_postal_mail

Boolean

Whether the customer agree to receive postal mails. false means to agree to receive promotional mails.

body[].customer_notes

String

Customer notes.

body[].customer_medical_alert

String

Customer medical alert.

body[].customer_general_alert

String

Customer general alert (staff use only).

body[].preferred_language_id

int

The preferred language of the customer. English= 1; French=2; Spanish=3

body[].families

Array

Family list to be add into.

body[].families[].family_id

int

Family ID.

body[].h_area

String

Home phone area code.

body[].h_phone

String

Home phone phone number.

body[].h_ext

String

Home phone extension number.

body[].w_area

String

Work phone area code.

body[].w_phone

String

Work phone phone number.

body[].w_ext

String

Work phone extension number.

body[].c_area

String

Cell phone area code.

body[].c_phone

String

Cell phone phone number.

body[].c_ext

String

Cell phone extension number.

Content-Type

application/json

headers

Object

response header.

headers.response_code

String

response code.

headers.response_message

String

response message.

body

Array

The response body.

body[].successfully_updated_customer

Array

The information of successfully updated customers.

body[].successfully_updated_customer[].customer_id

int

ActiveNet customer ID of the successfully updated customer.

body[].successfully_updated_customer[].first_name

String

First name of the successfully updated customer.

body[].successfully_updated_customer[].last_name

String

Last name of the successfully updated customer.

body[].successfully_updated_customer[].email

String

Email of the successfully updated customer.

body[].failed_updated_customer

Array

The information of the customers who failed to update.

body[].failed_updated_customer[].email

String

Email of the customer who failed to update.

body[].failed_updated_customer[].first_name

String

First name of the customer who failed to update.

body[].failed_updated_customer[].last_name

String

Last name of the customer who failed to update.

body[].failed_updated_customer[].failed_error

String

Error for the customer who failed to update.

photo_key

String

Mandatory

The key to retrieve the required customer photo. To determine the photo key for the required customer, call the GetCustomers API. In the API response, the photo_key field of the required customer record contains the photo key. Note that the photo_key is static for each customer. If the customer photo is updated in the AUI, the photo_key for the customer remains unchanged.

Content-Type

image/jpeg

Accept

application/json

Content-Type

application/json

page_info

In the HTTP request header, you can include page_info and specify required pagination or sorting parameters. Note that for this API, you can specify a number up to 500 for the total_records_per_page parameter.

activity_id

int

Mandatory (at least one of the following parameters must be provided: 'activity_id', 'package_id', 'program_id', 'permit_number', 'customer_id'.)

The ID of the activity. For the specified activity, all customers' answers to custom questions entered during activity registration are returned.

package_id

int

Mandatory (at least one of the following parameters must be provided: 'activity_id', 'package_id', 'program_id', 'permit_number', 'customer_id'.)

The ID of the package. For the specified membership package, all customers' answers to custom questions entered during enrollment are returned.

program_id

int

Mandatory (at least one of the following parameters must be provided: 'activity_id', 'package_id', 'program_id', 'permit_number', 'customer_id'.)

The ID of the FlexReg/daycare program. For the specified FlexReg/daycare program, all customers' answers to custom questions entered during program enrollment are returned.

permit_number

int

Mandatory (at least one of the following parameters must be provided: 'activity_id', 'package_id', 'program_id', 'permit_number', 'customer_id'.)

The number of the permit. For the specified permit, all customers' answers to custom questions entered during reservation are returned.

customer_id

int

Mandatory (at least one of the following parameters must be provided: 'activity_id', 'package_id', 'program_id', 'permit_number', 'customer_id'.)

The ID of the required customer. If only the customer_id parameter is provided, then this customer’s answers to custom questions entered during account creation are returned. If customer_id is provided together with other parameters, then the customer_id is used as a filter. For example, if activity_id and customer_id are provided, then custom questions answered by the specified customer for the specified activity during registration are returned.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].customer_id

int

Customer ID.

body[].first_name

String

Customer’s first name.

body[].last_name

String

Customer’s last name.

body[].question_answers

Array

Question and answers the customer answered.

body[].question_answers[].question

String

Custom question.

body[].question_answers[].question_id

int

ID of the custom question.

body[].question_answers[].answer

String

The answer of custom question. Multiple answers are separated by commas

body[].question_answers[].time_stamp

Datetime

The date and time when the customer answered the question.

body[].answer_for

String

The module in which the customer answered the question.

body[].receipt_number

BigDecimal

On which receipt the customer answered the question.

body[].activity_name

String

The name of the activity associated with the question and answer.

body[].activity_number

String

The number of the activity associated with the question and answer.

body[].activity_id

int

The activity ID of the activity associated with the question and answer.

body[].activity_status

String

The status of the activity associated with the question and answer.

body[].program_name

String

The name of the daycare program associated with the question and answer.

body[].program_number

String

The number of the daycare program associated with the question and answer.

body[].program_id

int

The program ID of the program associated with the question and answer.

body[].program_status

String

The status of the daycare program associated with the question and answer.

body[].event_type

String

The type of the event associated with the question and answer.

body[].event_name

String

The name of the event associated with the question and answer.

body[].permit_number

int

The number of the permit associated with the question and answer.

body[].permit_status

String

The status of the permit associated with the question and answer.

body[].package_name

String

The name of the package associated with the question and answer.

body[].package_id

int

The package ID of the package associated with the question and answer.

Content-Type

application/json

customer_ids

String

Mandatory

You can specify up to 500 customer IDs, with each ID separated by a comma.

Content-Type

application/json

headers

Object

The headers object in the response body.

headers.response_code

String

Response code (0000 indicates success).

headers.response_message

String

Response message.

body

Array

The body object in the response body.

body[].customer_id

int

The ID of the customer.

body[].prospect_answers[].question

String

Prospect custom question.

body[].prospect_answers[].answer

Array

The answers of prospect custom question. Multiple answers are separated by commas

Accept

application/json

Content-Type

application/json

custom_question_id

int

Mandatory (only one parameter among 'activity_id', 'package_id', 'program_id' and 'custom_question_id' should be specified)

The custom question ID.

activity_id

int

Mandatory (only one parameter among 'activity_id', 'package_id', 'program_id', 'event_type_id', 'account_creation_type' and 'custom_question_id' should be specified)

The activity ID. Questions associated with the activity are returned.

program_id

int

Mandatory (only one parameter among 'activity_id', 'package_id', 'program_id', 'event_type_id', 'account_creation_type' and 'custom_question_id' should be specified)

The daycare program ID. Questions associated with the daycare program are returned.

package_id

int

Mandatory (only one parameter among 'activity_id', 'package_id', 'program_id', 'event_type_id', 'account_creation_type' and 'custom_question_id' should be specified)

The package ID. Questions associated with the package are returned.

event_type_id

int

Mandatory (only one parameter among 'activity_id', 'package_id', 'program_id', 'event_type_id', 'account_creation_type' and 'custom_question_id' should be specified)

The id of the event type.

account_creation_type

int

Mandatory (only one parameter among 'activity_id', 'package_id', 'program_id', 'event_type_id', 'account_creation_type' and 'custom_question_id' should be specified)

The type of account creation: 1- individual; 2 - family

process

int

Optional

The process the questions are attached for. 1- All. Retrieve all questions attached to a package/activity/program; 2-Sale.It is only applicable for membership. Retrieve questions attached to a package except for 'renew only'; 3-Renew. It is only applicable for membership. Retrieve renew only questions attached to a package.

modified_date_from

YYYY-MM-DD HH:MM

Optional

Custom questions last updated on or after the specified date and time are returned (HH:MM is optional).

modified_date_to

YYYY-MM-DD HH:MM

Optional

Custom questions last updated on or before the specified date and time are returned (HH:MM is optional).

Content-Type