API changelog β February 15, 2023
Check out the API updates for this release.
Employee
API endpoint: http://{apiurl}/v1/employees/employeeid/signature
Scenario: Added the following parameters in response:
employee_name
employee_user_id
Earlier behavior: Additional parameters were not mentioned in the response.
New behavior: Additional parameters will now allow users to check the employeeβs name and user id.
API documentation link: NA
API endpoint: http://{apiurl}/api/employee/therapists
Scenario: Therapist description is now displayed in response to the βList all therapists of a centerβ API.
Earlier behavior: The therapistβs description was not displayed.
New behavior: With this release, users will see the therapist's description in response to the list of all therapists of a center.
API documentation link: List all therapists of a center
Memberships
API endpoint: http://{apiurl}/v1/guests/{guest_id}/memberships/{membership_id}/post_pone
Scenario: Use this API to delay annual or regular scheduled payments for memberships.
Earlier behavior: Regular and scheduled payments could not be changed or altered.
New behavior: With this release, you can postpone or delay a regular or scheduled membership payment.
API documentation link: NA
Forms
API endpoint: http://{apiurl}/v1/reports/forms/review/flat_file
Scenario: Added form filters and review stats in the request body.
Earlier behavior: Was returning form data based on existing filters.
New behavior: With this release, newly added parameters will return updated filters and review statistics.
API documentation link: NA
API endpoint: http://{apiurl}/v1/assets
Scenario: Added customforms parameter.
Earlier behavior: NA
New behavior: With this release, we have added a new parameter called customforms.
API documentation link: NA
API endpoint: http://{apiurl}/api/Appointments/appointment_id/HtmlCustomData?ViewContext=1&VersionNo=0
Scenario: Added a new parameter βIsFormReviewβ to the response object GetHtmlCustomDataResponse.
Earlier behavior: NA
New behavior: With this release, we are adding a new parameter βIsFormReviewβ in the response.
API documentation link: NA
API endpoint: http://{apiurl}/v1/forms/object_operators?object_type_id={object_type_id}&object_id={object_id}
Scenario: New API to fetch object operators.
Earlier behavior: NA
New behavior: Use this API to fetch all the object operators for your forms.
API documentation link: NA
API endpoint: http://{apiurl}/v1/forms/form_id/objects
Scenario: New API to fetch a formβs fields.
Earlier behavior: NA
New behavior: This new API will take a form as an input parameter and return the list of fields configured in the form. This API supports both v2 and v3 forms.
API documentation link: NA
API endpoint: http://{apiurl}/v1/classes/custom_forms
Scenario: Hardcoded job level parameter in the custom_forms API.
Earlier behavior: Currently, this API does not return job-level parameters which allow us to fetch the filteredforms.
New behavior: With this release, we have added a new parameter called job level.
API documentation link: NA
Donations
API endpoint: http://{{url}}/v1/reports/donations/flat_file?page={page}&size={size}
Scenario: New API to fetch the Donations v2 report.
Earlier behavior: NA
New behavior: Use this API to fetch the donations v2 report. You must specify the center_id, start_date, and end_date for the API to run.
API documentation link: NA