Change Updates

Do not miss any Pexip Engage API changes, ever again

Subscribe to the Pexip Engage API changelog to be up to date on recent changes.

RSS

Nov 29, 2023

staging
3.2.6
Compare
3.2.6

API structure has changed

42 structure changes including:
30 Additions
12 Modifications
Modified 12 Breaking
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Body
  • application/json content type Modified

    • Content type is now required

      Breaking

    • metadata property Modified

      • Removing polymorphism is always breaking

        Breaking

  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • metadata property Modified

      • Removing polymorphism is always breaking

        Breaking

  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • metadata property Modified

      • Removing polymorphism is always breaking

        Breaking

  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Added 30
PUT /subjects/{id}/availability-settings
PUT /offices/{id}/subject-availability-settings
PUT /listings/{listingId}/time-slots/{id}
PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
POST /listings/{listingId}/time-slots
POST /employees/{id}/unavailability
POST /employees/{id}/applied-templates
POST /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
POST /employees/{employeeId}/availability-templates
DELETE /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
DELETE /employees/{employeeId}/availability-templates/{id}
DELETE /employees/{id}/applied-templates
DELETE /employees/{id}/unavailability
DELETE /listings/{listingId}/time-slots/{id}
GET /defined-availability
GET /employees/{employeeId}/availability-templates
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
GET /employees/{employeeId}/availability-templates/{id}
GET /employees/{id}/applied-templates
GET /employees/{id}/unavailability
GET /listings/{listingId}/time-slots
GET /listings/{listingId}/time-slots/{id}
GET /offices/{id}/subject-availability-settings
GET /subjects/{id}/availability-settings
GET /timetable
GET /unavailability
PATCH /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
PATCH /employees/{employeeId}/availability-templates/{id}