REST API for Clinical One Platform

Update subject information

put

/ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}

Returns the mHealth subject ID as part of the response.All values listed in the 'body' of the API below are required fields to be completed as part of this API request. Please note that the following values have to be specified, however, these changes won't be applied (or these changes will take the current date for the timestamp), such as the field for 'dob','eventType','gender','informedConsentDate','screeningDate','stateDate','subjectTransferId','userId','versionStart'.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study for which you want to get the list of subjects.
subjectId(required): string

Subject ID to update.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

subject: object SubjectDto3

{
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/SubjectDto3"
        }
    }
}

Nested Schema : SubjectDto3

Type: object

Show Source

codeBreak: string
comment: string

Minimum Length: 0

Maximum Length: 2048
description: string

Minimum Length: 0

Maximum Length: 500
dob: string (date-time)
enrollmentFailure: string

Minimum Length: 0

Maximum Length: 255
enrollmentOverride: string

Minimum Length: 0

Maximum Length: 255
eventType: string
gender: string

Minimum Length: 0

Maximum Length: 10
id: string (uuid)
informedConsentDate: string (date-time)
objectVersionNumber: number
reason: string

Minimum Length: 0

Maximum Length: 255
screeningDate: string (date-time)
screeningFailure: string

Minimum Length: 0

Maximum Length: 255
siteId: string
state(required): string

Minimum Length: 0

Maximum Length: 100
stateDate: string (date-time)
studyId: string
studyVersion(required): string
subjectNumber(required): string

Minimum Length: 0

Maximum Length: 500
subjectTransferId: string (uuid)
userId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "format":"date-time"
        },
        "codeBreak":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "eventType":{
            "type":"string"
        },
        "subjectTransferId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "subjectNumber":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "dob":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "stateDate":{
            "type":"string",
            "format":"date-time"
        },
        "screeningFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentOverride":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "informedConsentDate":{
            "type":"string",
            "format":"date-time"
        },
        "gender":{
            "maxLength":"10",
            "minLength":"0",
            "type":"string"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

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(required): string
name: string

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

400 Response

Bad request.

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