Jump to

• Request
• Response

[Deprecated]: Add a subject

post

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects

Deprecated: Adds a subject to a study. Rights: DataCaptureSubjectPost and SubjectDataClassificationPost.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study to which the subject belongs.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Contains srcId of each subject

Show Source

• subjects(required): array subjects
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  subjects

{
    "required":[
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "maxItems":"2147483647",
            "minItems":"1",
            "type":"array",
            "description":"subjects",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Contains srcId of each subject"
}

Nested Schema : subjects

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

subjects

Show Source

• Array of: string(uuid)

{
    "maxItems":"2147483647",
    "minItems":"1",
    "type":"array",
    "description":"subjects",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

400 Response

Bad request.

Body ()

Root Schema : SubjectDto

Type: object

Show Source

• anchorKey: string
• values: array values

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object ValueDto

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

Nested Schema : ValueDto

Type: object

Show Source

• key: string
• keyType: string
• name: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "keyType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top