Qodex.ai

Find Events

GET {{url}}/{{tenantName}}/{{instanceName}}/calendar/events

  1. HTTP Method: GET
  2. HTTP URL: https://api.live.welkincloud.io/gh/sb-demo/calendar/events/

Example URLs:

  1. https://api.live.welkincloud.io/gh/sb-demo/calendar/events?from=2020-01-15T14:00:00.000Z&participantIds=301b2895-cbf0-4cac-b4cf-1d082faee95c&sort=createdAt,asc&to=2020-02-11T00:00:00.000Z&eventType=APPOINTMENT
  2. https://api.live.welkincloud.io/gh/sb-demo/calendar/events?from=2020-01-15T14:00:00.000Z&to=2020-02-11T00:00:00.000Z&eventType=ENCOUNTER&includeEncounterInfo=true

Request Params

KeyDatatypeRequiredDescription
tostringDate_time in ISO-8601 format , required
participantIdsstringList of id and values, either users or
eventTypestringEnum of allowed values ("GROUP_THERAPY", "APPOINTMENT", "LEAVE", "ENCOUNTER")
includeCancelledbooleanShould or not API return cancelled events (default: false)
includeEncountersInfobooleanShould or not API include encounterInfo field into dto (the field is exists for events with ENCOUNTER event type) (default: false)
fromstringDate_time in ISO-8601 format, required
excludeAssignedToEncounterEventsbooleanIf true, only events that are not assigned to encounter will returns (default: false)
sortstringAllows one to specify the sort order of the returned patients collection
viewerTimezonenull