API Change Log – February 2022 Release

Check the API updates for this release.

API End PointScenarioEarlier BehaviorNew BehaviorAPI Documentation Link
http://qaapi.zenoti.com/api/Appointments/QueueTo 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 previouslyTherapist_Display_Name parameter will start showing up in the response objectNA
http://devapi.zenoti.com/api/Catalog/Services/CategoriesisDraft added to indicate to whether to fetch published/draft asset's (image's) web access pathFetch 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/guestsWe 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 apiis_virtual_employee was not shown in responseis_virtual_employee is shown in response when org and center setting is onNA
https://qaapi.zenotibeta.com/api/Guests/AddNAAPI was working only for employee token and webstore null token.API will work for guests.NA
http://devapi.zenoti.com/v1/reports/collections/flat_fileNANAAdded a new propertyNA
http://devapi.zenoti.com/v1/invoices/b4eac81d-e553-430c-a599-0dd143d0d4f2/Payroll_lock?check_for_all_employees=1NADid not contain multiLevelLockContains multiLevelLockNA
http://devapi.zenoti.com/api/Catalog/Appointments/AvailabletimesNASince "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}/AppointmentSettingsNAenable_waiting_room was not present in responseenable_waiting_room is present in responseNA
GET v1/organizations/settings/{section}NAParameter "virtual_meeting_creation" was not present in responseNew parameter "virtual_meeting_creation" of type int will be added in responseNA
http://apizarhfx.zenotibeta.com/v1/group_invoices%7Chttp:/apizarhfx.zenotibeta.com/v1/group_invoicesCurrently, 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 emptyWon'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/appointmentsRetrieve list of appointments of a center - Product – APIOnly appointment details were shownBoth appointment and virtual meeting details of appointment will be shownRetrieve the list of appointments of a center