• events: array events

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

• Array of: object EventsByType
  Object for event details.

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

• 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":"IDs of the events",
                "format":"uuid"
            }
        }
    },
    "description":"Object for event details."
}

• Array of: string(uuid)
  IDs of the events

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"IDs of the events",
        "format":"uuid"
    }
}

• 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."
}

• 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."
        }
    },
    "description":"Error Response Details Information"
}