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

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