To understand how many API calls are required to download all requested data, refer to the list below and select the required API.
This chapter includes the following APIs:
General:
Activity:
Customer:
Facility:
Financial:
Flex Registration program:
Membership:
This API returns information about the organization in a single API request.
This API returns all sites in a single API request, no matter how many sites are in your organization.
This API returns all centers in a single API request, no matter how many centers are in your organization.
This API returns all seasons in a single API request, no matter how many seasons are in your organization.
This API returns all skills in a single API request, no matter how many skills are in your organization.
This API returns customer information for a valid customer login.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls required to download all activities is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetActivities API to retrieve all requested activities in site H (site_id is 8):
Make the following API call:
https://api.amp.active.com/....../api/v1/activities?site_ids=8&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "activity_id",
"order_option": "ASC",
"page_number": 1,
"total_records": 998,
"total_records_per_page": 50,
"total_page": 20
}
},
The total number of requested records (total_records) is 998, and the number of API calls required to download all requested records (total_page) is 20.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/activities?site_ids=8&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "activity_id",
"order_option": "ASC",
"page_number": 1,
"total_records": 998,
"total_records_per_page": 500,
"total_page": 2
}
},
The total number of requested records (total_records) is still 998, but the number of API required calls to download all requested records (total_page) is now 2.
For more information about request header parameters, refer to Common header parameters.
The number of API calls required to download all requested data is equal to the total number of activities for which you are attempting to retrieve information. To retrieve detailed information for all requested activities, repeat the API call using different activity IDs.
For example, if your organization has 201 activities, then 201 API calls are required to download all activities.
Each API call is for a single activity_id, so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/activities/1?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/activities/2?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/activities/3?api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/activities/201?api_key=yourAPIkey
This API returns all activity categories in a single API request, no matter how many activity categories are in your organization.
This API returns all activity other categories in a single API request, no matter how many activity other categories are in your organization.
The number of API calls required to download all requested data is equal to the total number of activities for which you are attempting to retrieve fee information. To retrieve fees for the required activities, repeat the API call using different activity IDs.
For example, if your organization has 201 activities, then 201 API calls are required to download all activity fees.
Each API call is for a single activity_id, so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/activities/1/fees?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/activities/2/fees?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/activities/3/fees?api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/activities/201/fees?api_key=yourAPIkey
This API returns all activity types in a single API request, no matter how many activity types are in your organization.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls required to download requested activity enrollments is determined by the request parameters and pagination.
If you make an API call with specified request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetActivityEnrollment API to retrieve all enrollments for an activity (activity_id is 8195):
Make the following API call:
https://api.amp.active.com/....../api/v1/activityenrollment?activity_id=8195&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "customer_id",
"order_option": "ASC",
"page_number": 1,
"total_records": 998,
"total_records_per_page": 50,
"total_page": 20
}
},
The total number of requested records (total_records) is 998, and the number of API calls required to download all requested records (total_page) is 20.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/activityenrollment?activity_id=8195&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "customer_id",
"order_option": "ASC",
"page_number": 1,
"total_records": 998,
"total_records_per_page": 500,
"total_page": 2
}
},
The total number of requested records (total_records) is still 998, but the number of API required calls to download all requested records (total_page) is now 2.
For more information about request header parameters, refer to Common header parameters.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download expanded details for requested activities is determined by the request parameters and pagination.
If you make an API call with specified request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetActivityExpandedDetail API to retrieve expanded details for multiple activities (activity_ids are 115 and 118):
Make the following API call:
https://api.amp.active.com/....../api/v1/activityexpandeddetail?activity_ids=115,118&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "activity_id",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 20
}
},
The total number of requested records (total_records) is 998, and the number of API calls required to download all requested records (total_page) is 20.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/activityexpandeddetail?activity_ids=115,118&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "activity_id",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 500,
"total_page": 2
}
},
The total number of requested records (total_records) is still 998, but the number of API required calls to download all requested records (total_page) is now 2.
For more information about request header parameters, refer to Common header parameters.
This API returns all activity dates for the specified activity ID in a single API request, no matter how many activity dates are in your organization.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download all requested customers is determined by the request parameters and pagination.
If you make an API call with specified request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetCustomers API to retrieve all customers:
Make the following API call:
https://api.amp.active.com/....../api/v1/customers?api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "customer_id",
"total_records": 27054,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 542
}
},
The total number of requested records (total_records) is 27054, and the number of API calls required to download all requested records (total_page) is 55.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/customers?site_ids=8&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "customer_id",
"total_records": 27054,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 500,
"total_page": 55
}
},
The total number of requested records (total_records) is still 27054, but the number of API required calls to download all requested records (total_page) is now 55.
For more information about request header parameters, refer to Common header parameters.
The number of API calls required to download all requested data is equal to the total number of custom questions for which you are attempting to retrieve information. To retrieve all requested custom questions, repeat the API call using different activity IDs.
For example, if your organization has 19 custom questions, then 19 API calls are required to download all custom questions.
Each API call is for a single 'activity_id', 'package_id', 'program_id' or 'custom_question_id', so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/customquestions?custom_question_id=1&api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/customquestions?custom_question_id=2&api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/customquestions?custom_question_id=3&api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/customquestions?custom_question_id=19&api_key=yourAPIkey
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download answers to requested custom questions is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetCustomQuestionAnswers API to retrieve all answers made by a customer (customer_id is 218):
Make the following API call:
https://api.amp.active.com/....../api/v1/customquestionanswers?customer_id=218&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "customer_id",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 20
}
},
The total number of requested records (total_records) is 998, and the number of API calls required to download all requested records (total_page) is 20.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/customquestionanswers?customer_id=218&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "customer_id",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 500,
"total_page": 2
}
},
The total number of requested records (total_records) is still 998, but the number of API required calls to download all requested records (total_page) is now 2.
For more information about request header parameters, refer to Common header parameters.
This API downloads the customer photo for the specified photo_key.
The number of API calls required to download all requested data is equal to the total number of customers for which you are attempting to download customer photo. To download all requested customer photos, repeat the API call using different photo keys.
For example, if your organization has 819 customers, then 819 API calls are required to download all custom photos.
Each API call is for a single photo_key, so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/customerphoto?photo_key=010FD14A2F&api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/customerphoto?photo_key=022FA14A2F&api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/customerphoto?photo_key=03BA982ED2&api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/customerphoto?photo_key=035AC14A33&api_key=yourAPIkey
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download all requested facilities is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetFacilities API to retrieve all facilities:
Make the following API call:
https://api.amp.active.com/....../api/v1/facilities?api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "facility_id",
"total_records": 1383,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 28
}
},
The total number of requested records (total_records) is 1383, and the number of API calls required to download all requested records (total_page) is 28.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/facilities?api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "facility_id",
"total_records": 1383,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 500,
"total_page": 3
}
},
The total number of requested records (total_records) is still 1383, but the number of API required calls to download all requested records (total_page) is now 3.
For more information about request header parameters, refer to Common header parameters.
The number of API calls required to download all requested data is equal to the total number of facilities for which you are attempting to retrieve information. To retrieve detailed information for all requested facilities, repeat the API call using different facility IDs.
For example, if your organization has 75 facilities, then 75 API calls are required to download all facilities.
Each API call is for a single facility_id, so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/facilities/1?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/facilities/2?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/facilities/3?api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/facilities/75?api_key=yourAPIkey
This API returns all facility types in a single API request, no matter how many facility types are in your organization.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 200.
The number of API calls to download all facility schedules is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetFacilitySchedules API to retrieve facility schedules for the specified facilities during the specified date range (facility_ids are 21, 23, 27):
Make the following API call:
https://api.amp.active.com/....../api/v1/facilityschedules?date_from=2022-07-01&date_to=2022-12-31&facility_ids=21,23,27&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "facility_name",
"total_records": 440,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 9
}
},
The total number of requested records (total_records) is 440, and the number of API calls required to download all requested records (total_page) is 9.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (200).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/facilityschedules?date_from=2022-07-01&date_to=2022-12-31&facility_ids=21,23,27&api_key=yourAPIkey
set total_records_per_page to 200.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "facility_name",
"total_records": 440,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 200,
"total_page": 3
}
},
The total number of requested records (total_records) is still 440, but the number of API required calls to download all requested records (total_page) is now 3.
For more information about request header parameters, refer to Common header parameters.
The number of API calls required to download all requested data is equal to the total number of facilities for which you are attempting to retrieve open hour information. To retrieve open hour information for all requested facilities, repeat the API call using different facility IDs.
For example, if your organization has 75 facilities, then 75 API calls are required to download default facility opening/closing hours and facility open/close hours for all facilities.
Each API call is for a single facility_id, so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/facilityopenhours/1?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/facilityopenhours/2?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/facilityopenhours/3?api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/facilityopenhours/75?api_key=yourAPIkey
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download facility charges is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetFacilityChargeMatrix API to retrieve all charges for a customer type (customer_type_id is 3):
Make the following API call:
https://api.amp.active.com/....../api/v1/facilitychargematrix?search_type=0&customer_type_id=3&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "charge_name",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 20
}
},
The total number of requested records (total_records) is 998, and the number of API calls required to download all requested records (total_page) is 20.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/facilitychargematrix?search_type=0&customer_type_id=3&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "charge_name",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 500,
"total_page": 2
}
},
The total number of requested records (total_records) is still 998, but the number of API required calls to download all requested records (total_page) is now 2.
For more information about request header parameters, refer to Common header parameters.
This API returns all event types in a single API request, no matter how many event types are in your organization.
This API returns all reservation groups in a single API request, no matter how many reservation groups are in your organization.
This API returns all prep codes in a single API request, no matter how many prep codes are in your organization.
This API returns all schedule types in a single API request, no matter how many schedule types are in your organization.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download all skip dates for the required facility is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetSkipDates API to retrieve all skip dates for the required facility (facility_id is 33):
Make the following API call:
https://api.amp.active.com/....../api/v1/skipdates?facility_id=33&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "start_date",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 20
}
},
The total number of requested records (total_records) is 998, and the number of API calls required to download all requested records (total_page) is 20.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/skipdates?facility_id=33&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "start_date",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 500,
"total_page": 2
}
},
The total number of requested records (total_records) is still 998, but the number of API required calls to download all requested records (total_page) is now 2.
For more information about request header parameters, refer to Common header parameters.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download all schedules is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download all schedules is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download all FlexReg programs is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetFlexRegPrograms API to retrieve all programs:
Make the following API call:
https://api.amp.active.com/....../api/v1/flexregprograms?api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "program_id",
"total_records": 1602,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 33
}
},
The total number of requested records (total_records) is 1602, and the number of API calls required to download all requested records (total_page) is 33.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/flexregprograms?api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "program_id",
"total_records": 1602,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 500,
"total_page": 4
}
},
The total number of requested records (total_records) is still 1602, but the number of API required calls to download all requested records (total_page) is now 4.
For more information about request header parameters, refer to Common header parameters.
The number of API calls required to download all requested data is equal to the total number of FlexReg programs for which you are attempting to retrieve detailed information. To retrieve detailed information for all requested programs, repeat the API call using different program IDs.
For example, if your organization has 75 programs, then 75 API calls are required to download all programs.
Each API call is for a single program_id, so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/flexregprograms/1?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/flexregprograms/2?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/flexregprograms/3?api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/flexregprograms/75?api_key=yourAPIkey
The number of API calls required to download all requested data is equal to the total number of FlexReg programs for which you are attempting to retrieve fee information. To retrieve fee information for all requested programs, repeat the API call using different program IDs.
For example, if your organization has 75 programs, then 75 API calls are required to download all program fees.
Each API call is for a single program_id, so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/flexregprograms/1/fees?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/flexregprograms/2/fees?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/flexregprograms/3/fees?api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/flexregprograms/75/fees?api_key=yourAPIkey
This API returns all FlexReg program types in a single API request, no matter how many FlexReg program types are in your organization.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 200.
The number of API calls to download all FlexReg enrollments is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetFlexRegEnrollment API to retrieve all program enrollments for a program (program_id is 137):
Make the following API call:
https://api.amp.active.com/....../api/v1/flexregenrollment?program_id=137&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "program_id",
"total_records": 413,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 9
}
},
The total number of requested records (total_records) is 413, and the number of API calls required to download all requested records (total_page) is 9.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (200).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/flexregenrollment?program_id=137&api_key=yourAPIkey
specify total_records_per_page as 200.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "program_id",
"total_records": 413,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 200,
"total_page": 3
}
},
The total number of requested records (total_records) is still 413, but the number of API required calls to download all requested records (total_page) is now 3.
For more information about request header parameters, refer to Common header parameters.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download expanded details for a FlexReg program or session is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetFlexregExpandedDetail API to retrieve all expanded details for a program (program_id is 33):
Make the following API call:
https://api.amp.active.com/....../api/v1/flexregexpandeddetail?program_id=33&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "program_id",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 20
}
},
The total number of requested records (total_records) is 998, and the number of API calls required to download all requested records (total_page) is 20.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/flexregexpandeddetail?program_id=33&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "program_id",
"total_records": 998,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 500,
"total_page": 2
}
},
The total number of requested records (total_records) is still 998, but the number of API required calls to download all requested records (total_page) is now 2.
For more information about request header parameters, refer to Common header parameters.
This API returns all FlexReg program dates for the requested FlexReg program in a single API request, no matter how many FlexReg program dates are in the requested FlexReg program.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 200.
The number of API calls to download all membership packages is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetMembershipPackages API to retrieve all membership packages:
Make the following API call:
https://api.amp.active.com/....../api/v1/membershippackages?api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "program_id",
"total_records": 1869,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 50,
"total_page": 38
}
},
The total number of requested records (total_records) is 1869, and the number of API calls required to download all requested records (total_page) is 38.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (200).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/membershippackages?api_key=yourAPIkey
set total_records_per_page to 200.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "program_id",
"total_records": 1869,
"order_option": "ASC",
"page_number": 1,
"total_records_per_page": 200,
"total_page": 10
}
},
The total number of requested records (total_records) is still 1869, but the number of API required calls to download all requested records (total_page) is now 10.
For more information about request header parameters, refer to Common header parameters.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 200.
The number of API calls to download all memberships is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetMemberships API to retrieve all memberships for a package (package_id is 123):
Make the following API call:
https://api.amp.active.com/....../api/v1/memberships?package_id=123&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "membership_id",
"total_records_per_page": 50,
"total_records": 408,
"page_number": 1,
"order_option": "ASC",
"total_page": 9
}
},
The total number of requested records (total_records) is 408, and the number of API calls required to download all requested records (total_page) is 9.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (200).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/memberships?package_id=123&api_key=yourAPIkey
set total_records_per_page to 200.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "membership_id",
"total_records_per_page": 200,
"total_records": 408,
"page_number": 1,
"order_option": "ASC",
"total_page": 3
}
},
The total number of requested records (total_records) is still 408, but the number of API required calls to download all requested records (total_page) is now 3.
For more information about request header parameters, refer to Common header parameters.
This API returns all membership package categories in a single API request, no matter how many membership package categories are in your organization.
This API’s responses are paginated. The default number of records that can be retrieved per API request is 50 and the maximum number (which you may set) is 500.
The number of API calls to download all requested membership usages is determined by the request parameters and pagination.
If you make an API call with specific request parameters, then in the API response HTTP body, the:
total_records field contains the total number of records that match the request parameters
total_page field contains the number of API calls required to retrieve the above number (total_records) of records.
If total_page is:
one, then the current API response contains all matching records.
greater than one, then the current API response contains only some of the matching records. To receive all remaining matching records, repeat the API call total_page times with a different page_number in the request header for each call.
For example, to use the GetMembershipUsages API to retrieve all membership usage information in the specified date (Dec 1, 2018):
Make the following API call:
https://api.amp.active.com/....../api/v1/membershipusages?usage_date=2018-12-01&api_key=yourAPIkey
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "membershipusage_id",
"total_records_per_page": 50,
"total_records": 998,
"page_number": 1,
"order_option": "ASC",
"total_page": 20
}
},
The total number of requested records (total_records) is 998, and the number of API calls required to download all requested records (total_page) is 20.
If you wish to retrieve all requested data using the lowest number of API calls, then set the total_records_per_page parameter to the maximum number for this API (500).
In the HTTP header of the API call,
https://api.amp.active.com/....../api/v1/membershipusages?usage_date=2018-12-01&api_key=yourAPIkey
set total_records_per_page to 500.
In the HTTP body of the API response:
{
"headers": {
"response_code": "0000",
"response_message": "Successful",
"page_info": {
"order_by": "membershipusage_id",
"total_records_per_page": 500,
"total_records": 998,
"page_number": 1,
"order_option": "ASC",
"total_page": 2
}
},
The total number of requested records (total_records) is still 998, but the number of API required calls to download all requested records (total_page) is now 2.
For more information about request header parameters, refer to Common header parameters.
The number of API calls required to download all requested data is equal to the total number of membership packages for which you are attempting to retrieve fee information. To retrieve fee information for all requested packages, repeat the API call using different package IDs.
For example, if your organization has 75 membership packages, then 75 API calls are required to download all package fees.
Each API call is for a single package ID, so an example set of API calls can be as follows:
https://api.amp.active.com/....../api/v1/membershippackages/1/fees?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/membershippackages/2/fees?api_key=yourAPIkey
https://api.amp.active.com/....../api/v1/membershippackages/3/fees?api_key=yourAPIkey
…
https://api.amp.active.com/....../api/v1/membershippackages/75/fees?api_key=yourAPIkey
Retrieving data from ACTIVE Net