Get schedules

Get Schedules

Get /schedules/

Caching for Fair use

Cache the results of this call on your side for e.g. 1 hour or more to prevent causing unnecessary load on our API servers, especially for high volume traffic.

Request Parameters

See HTTP Request Headers

Parameters indicated with a * are mandatory

Parameter	Type	Description
page	int	used for pagination to indicate which page should return
pageSize	int	used for pagination to indicate how many results should be given. By default 100 schedules will be returned.
IsActivated	boolean	Schedule is activated: true if active false is inactive
IsArchived	boolean	Schedule is archived: true if active false is inactive For archiving a schedule see api 'Archive schedule'
IsAnonymized	boolean	Schedule is anonymized: true if active false is inactive
IsMarkedForAnonymization	boolean	Schedule is marked for anonymization: true if active false is inactive
MinAnonymizationDate	date	Filter exams that are anonymized after given date format: DDMMYYYY
IsAllPublished	boolean	Results are all published (completed marking)
MaxPublishDate	boolean	Filter exams that are published before date: format: DDMMYYYY
MaxEndDate	boolean	Filter exams that are ending (schedule end date) before date: format: DDMMYYYY

Pagination

Pagination is enabled for this call. the parameters that control the pagination are 'page' and 'pageSize', indicating the desired item per page. The maximum limit value is 100 schedules.

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/schedules?IsActivated=true&IsAnonymized=true

Sample successfull Response

If a value is not set, e.g. AnonymizationDate it will be included with a value of null.

[
  {
    "ExternalID": "MB0-00123",
    "Title": "Exam 2",
    "EndDate": "DD-MM-YYYYThh:mm:ss.xxxZ",
    "PublishDate": "DD-MM-YYYYThh:mm:ss.xxxZ",
    "IsActivated": true,
    "IsArchived": true,
    "IsAllPublished": true,
    "IsAnonymized": true,
    "IsMarkedForAnonymization": true,
    "MarkedForAnonymizationDate": "DD-MM-YYYYThh:mm:ss.xxxZ",
    "AnonymizationDate": "DD-MM-YYYYThh:mm:ss.xxxZ"  
  },
 ...
]

Responses

Code	Description
200	Successful operation