API End Point

Scenario

Earlier Behavior

New Behavior

API Doc Link

http://qaapi.zenoti.com/api/Appointments/Queue

To resolve the above ticket, a new parameter named *Therapist_Display_Name* is added in the GetQueue API response object. This parameter contains Employee catalog display name.

Therapist_Display_Name was not there previously

Therapist_Display_Name parameter will start showing up in the response object

NA

http://devapi.zenoti.com/api/Catalog/Services/Categories

isDraft added to indicate to whether to fetch published/draft asset's (image's) web access path

Fetch catalog service categories with published asset (image associated with category)

Fetch catalog service categories with published/draft asset (image associated with category) based on isDraft flag.

NA

http://devapi.zenoti.com/v1/guests

We need to expose the user preferred language option under profile section for guests. This will be used to identify the language in which the user would want to browse webstore or receive the communication updates in.

Guest's Language Id was not fetched as part of response.

Language Id is fetched as part of the response.

NA

api/Employees/\{employee_id}

Get virtual_employee flag in employee details api

is_virtual_employee was not shown in response

is_virtual_employee is shown in response when org and center setting is on

NA

https://qaapi.zenotibeta.com/api/Guests/Add

NA

API was working only for employee token and webstore null token.

API will work for guests.

NA

http://devapi.zenoti.com/v1/reports/collections/flat_file

NA

NA

Added a new property

NA

http://devapi.zenoti.com/v1/invoices/b4eac81d-e553-430c-a599-0dd143d0d4f2/Payroll_lock?check_for_all_employees=1

NA

did not contain multiLevelLock

contains multiLevelLock

NA

http://devapi.zenoti.com/api/Catalog/Appointments/Availabletimes

NA

Since "CheckAvailableTherapistsWaitTime" request parameter is not there in old behaviour, API did not have AvailableTherapistsStartTimesInCenter object in response as well.

If we set "CheckAvailableTherapistsWaitTime" request parameter to true, API Will have AvailableTherapistsStartTimesInCenter object in response.

NA

GET api/Centers/\{CenterId}/AppointmentSettings

NA

enable_waiting_room was not present in response

enable_waiting_room is present in response

NA

GET v1/organizations/settings/{section}

NA

Parameter "virtual_meeting_creation" was not present in response

New parameter "virtual_meeting_creation" of type int will be added in response

NA

http://apizarhfx.zenotibeta.com/v1/group_invoices|http://apizarhfx.zenotibeta.com/v1/group_invoices

Currently, we can create Group Invoice by passing Group Name as Null and we should not allow it at the API level.

Able to create Group Invoice by passing Group Name as Null or empty

Won't be able to create Group Invoice by passing Group Name as Null or empty, an error message will be thrown "Invalid GroupName"

NA

http://devapi.zenoti.com/v1/appointments

Retrieve list of appointments of a center - Product – API

Only appointment details were shown

Both appointment and virtual meeting details of appointment will be shown

API Documentation

http://devapi.zenoti.com/v1/employees/CheckIn

NA

Non-existent previously

Non-existent previously

API Documentation

http://devapi.zenoti.com/v1/employees/CheckIn

API to get the therapist details at center level

The API used to return the therapist details without the work task ID

API Documentation

http://devapi.zenoti.com/v1/employees/CheckIn

NA

Request did not contain WorktaskID

Request will contain WorktaskID when the organization setting is enabled.

API Documentation

http://devapi.zenoti.com/v1/organizations/settings/Employee?expand=work_task

NA

API response did not contain primaryworktask settings

API response will contain primaryworktask settings

API Documentation

https://apiasia01.zenoti.com/v1/centers/583d9def-9c38-4338-a85e-f6a0bf3d83bd/Attendance?Date=2021-12-10

API to get attendance for an employee

No work_task_id parameter in the response

work_task_id included in response if expand value provided appropriately

API Documentation

https://apiasia01.zenoti.com/v1/centers/583d9def-9c38-4338-a85e-f6a0bf3d83bd/attendance

API to get center employees attendance

No work_task_id parameter in the response

work_task_id included in response if expand value provided appropriately

API Documentation

https://devapi.zenoti.com/v1/issues

NA

Guest details contains "Name, Phone number and Guest ID"

Guest details contains "Name, Phone number, Guest ID , Guest code and Guest email"

NA

api/Catalog/Appointments/ReserveSlots

The Reserve Slot API should support *no service selection* scenario (Queue) i.e., it should work when no service info is sent as part of request params. *--- Dummy service ID will be sent.*

NA

NA

NA

{{GET: v1/organizations/online_settings/cma}}

NA

Fetched only published setting values

Fetch either published or draft setting values based on input.

NA

http://devapi.zenoti.com/api/Organizations/IdOrAccountName

Guests have access to API

Cross-Org details can be fetched

Guests cannot access the API

Cross-Org details cannot be fetched

NA

http://devapi.zenoti.com/v1/reports/collections/item_level/flat_file?page=1&size=1

Defects : 1) Getting Collection by item report by passing Null or empty value for collection_to_sale_date_type.

2)Getting Collection by item report by passing Invalid/Empty/Null/without passing collection_centers_type.

3)Getting Collection by item report by passing Null/Empty invoice_centers_type



Change: Checking this parameters for NULL values or invalid values or count =0 case.

Able to get the report for the mentioned invalid parameters

Throws an error when we get Collection by item report with Invalid/Empty/Null value for collection_to_sale_date_type, collection_centers_type, invoice_centers_type

NA

http://devapi.zenoti.com/v1/reports/packages/flat_file?page=1&size=1

Defect : Able to get package report by passing date_type as Expiry with Invalid/Empty/Null value for include_no_expiry.

Able to get package report by passing date_type as Expiry with Invalid/Empty/Null value for include_no_expiry

Throws an error when we get packages report by passing date_type as Expiry with Invalid/Empty/Null value for include_no_expiry

NA

http://devapi.zenoti.com/v1/reports/packages/benefits/flat_file

Able to get package benefits report by passing date_type as Expiry with Invalid/Empty/Null value for include_no_expiry

Able to get package benefits report by passing date_type as Expiry with Invalid/Empty/Null value for include_no_expiry

Throws an error when we get package benefits report by passing date_type as Expiry with Invalid/Empty/Null value for include_no_expiry

NA

http://devapi.zenoti.com/api/Catalog//Services?CenterId=d1fb6a44-0d35-4992-aa96-24b58cd79369&size=50&OrganizationId=b5b9397d-d7bc-444d-966f-6535e83c6ac3&categoryType=0&Attributes=21,22,23,24

NA

Results not sorted by Service Display Name

Results are sorted by Service Display Name

NA

http://devapi.zenoti.com/v1/Centers?catalog_enabled=true&page=1&search_text=Hyd&size=5

Search parameters:

Center Name, Center Display Name, Zip code, Address, City, State, OR Country.

Search results returned all the center’s information.

Added searching functionality to center list API

NA

Did this answer your question?