Show Source

• id: string (uuid)
• previousState: string
  Allowed Values: [ "settings", "active", "design", "test", "training" ]

  Previous state of a study for UI consumption

  Example: training
• studyState: string
  Allowed Values: [ "settings", "active", "design", "test", "training" ]

  State of a study for UI consumption

  Example: active

{
    "title":"StudyStateDto v1.0",
    "type":"object",
    "properties":{
        "studyState":{
            "type":"string",
            "description":"State of a study for UI consumption",
            "example":"active",
            "enum":[
                "settings",
                "active",
                "design",
                "test",
                "training"
            ]
        },
        "previousState":{
            "type":"string",
            "description":"Previous state of a study for UI consumption",
            "example":"training",
            "enum":[
                "settings",
                "active",
                "design",
                "test",
                "training"
            ]
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Information about the state of a study for UI consumption."
}

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

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