Show Source

• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Treatment Arm Description

  Example: Monad NP (60ml) Syrup
• id: string (uuid)
  Treatment Arm GUID
• shortName(required): string
  Minimum Length: 1

  Maximum Length: 64

  Treatment Arm Short Name

  Example: Drug
• studyId: string (uuid)
  Study ID
• studyVersionEnd: string (date-time)
  Study Version End

  Example: 3099-12-31T05:00:00Z
• studyVersionStart: string (date-time)
  Study Version Start
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Treatment Arm Title

  Example: TxA
• versionEnd: string (date-time)
  Version End

  Example: 3099-12-31T05:00:00Z
• versionStart: string (date-time)
  Version Start

{
    "title":"ArmDto v1.0",
    "required":[
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Treatment Arm GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Treatment Arm Title",
            "example":"TxA"
        },
        "shortName":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Treatment Arm Short Name",
            "example":"Drug"
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Treatment Arm Description",
            "example":"Monad NP (60ml) Syrup"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time",
            "example":"3099-12-31T05:00:00Z"
        },
        "studyId":{
            "type":"string",
            "description":"Study ID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study Version Start",
            "format":"date-time"
        },
        "studyVersionEnd":{
            "type":"string",
            "description":"Study Version End",
            "format":"date-time",
            "example":"3099-12-31T05:00:00Z"
        }
    },
    "description":"Treatment arm details."
}

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