Contents x
    Get schedules
    • 30 Jun 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get schedules

    • Updated on 30 Jun 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    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

    ParameterTypeDescription
    pageintused for pagination to indicate which page should return
    pageSizeintused for pagination to indicate how many results should be given. By default 100 schedules will be returned.
    IsActivatedbooleanSchedule is activated:
    true if active
    false is inactive
    IsArchivedbooleanSchedule is archived:
    true if active
    false is inactive
    For archiving a schedule see api 'Archive schedule'
    IsAnonymizedbooleanSchedule is anonymized:
    true if active
    false is inactive
    IsMarkedForAnonymizationbooleanSchedule is marked for anonymization:
    true if active
    false is inactive
    MinAnonymizationDatedateFilter exams that are anonymized after given date
    format: DDMMYYYY
    IsAllPublishedbooleanResults are all published (completed marking)
    MaxPublishDatebooleanFilter exams that are published before date:
    format: DDMMYYYY
    MaxEndDatebooleanFilter 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

    CodeDescription
    200Successful operation
    Was this article helpful?
    What's Next