Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events

Retrieves a list of events in a study based on start date and end date. Rights: OrsSubjectVisitGet. If no events are specified, all the events in action types are returned. If event types are specified, but none of them are valid, an empty list is returned.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  A1B2C3D4E5F6478899AABBCCDDEEFF00

Query Parameters

• endDate(required): string
  Pattern: ^(0[1-9]|[12]\d|3[01])-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-\d{4} ([01]\d|2[0-3]):[0-5]\d$

  End date and time in dd-MMM-yyyy HH:mm format.

  Example:

  31-Jan-2026 23:59

• events: array[string]
  List of events.

  Example:

  RANDOMIZATION

• startDate(required): string
  Pattern: ^(0[1-9]|[12]\d|3[01])-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-\d{4} ([01]\d|2[0-3]):[0-5]\d$

  Start date and time in dd-MMM-yyyy HH:mm format.

  Example:

  01-Jan-2026 00:00

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : EventsDTO

Type: object

Response object for Events API.

Show Source

• events: array events

{
    "type":"object",
    "properties":{
        "events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EventsByType"
            }
        }
    },
    "description":"Response object for Events API."
}

Nested Schema : events

Type: array

Show Source

• Array of: object EventsByType
  Event details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EventsByType"
    }
}

Nested Schema : EventsByType

Type: object

Event details.

Show Source

• eventType: string
  Allowed Values: [ "New", "Screened", "Randomized" ]

  Event type.

  Example: New
• ids: array ids

{
    "type":"object",
    "properties":{
        "eventType":{
            "type":"string",
            "description":"Event type.",
            "example":"New",
            "enum":[
                "New",
                "Screened",
                "Randomized"
            ]
        },
        "ids":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Event IDs.",
                "format":"uuid"
            }
        }
    },
    "description":"Event details.",
    "example":{
        "eventType":"New",
        "ids":[
            "B1B8327AFAA6412287106192AB5984EF"
        ]
    }
}

Example:

{
    "eventType":"New",
    "ids":[
        "B1B8327AFAA6412287106192AB5984EF"
    ]
}

Nested Schema : ids

Type: array

Show Source

• Array of: string(uuid)
  Event IDs.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Event IDs.",
        "format":"uuid"
    }
}

Examples

Select an example Events Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example Get Events Server Error Response

Back to Top