Show Source

• Array of: object VersionDto v1.0
  Title: VersionDto v1.0

  Information about a study version.

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

Show Source

• id: string (uuid)
  Study GUID
• status: string
  Status of study

  Example: DRAFT
• studyVersion: string
  The study version

  Example: 2.0.0.7
• versionTitle: string
  Name of the latest study version

  Example: Study03:2.0.0.7
• versionType: string
  Type of study version

  Example: PROTOCOL_AMENDMENT

{
    "title":"VersionDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"The study version",
            "example":"2.0.0.7"
        },
        "status":{
            "type":"string",
            "description":"Status of study",
            "example":"DRAFT"
        },
        "versionTitle":{
            "type":"string",
            "description":"Name of the latest study version",
            "example":"Study03:2.0.0.7"
        },
        "versionType":{
            "type":"string",
            "description":"Type of study version",
            "example":"PROTOCOL_AMENDMENT"
        }
    },
    "description":"Information about a study version."
}

Show Source

• details: string
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

  Example: User role is missing required permission REPORTING_VIEW. Field: userId
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}