Sign subject and visits
post
/ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
Signs a subject and all completed visits in the subject. Repeating sections supported.
Rights: DataCaptureSubjectPost and SubjectDataClassificationPost.
Rights: DataCaptureSubjectPost and SubjectDataClassificationPost.
Request
Path Parameters
-
code(required): string
Code is sent via IAMS as initial sign
-
mode(required): string
Mode of the study. Accepts test, active, or training.
-
orgId(required): string
IAMS Tenant Short Org ID
-
studyId(required): string
ID of the study to which the subject belongs.
-
studyVersion(required): string
Study version associated to subject's site.
-
subjectId(required): string
ID of the current subject to sign.
Query Parameters
-
redirectUriHostname: string
Redirect URI
Supported Media Types
- application/json
Response
Supported Media Types
- application/json
200 Response
Subjects sign success
Nested Schema : SignVerifyFreezeDTOv30
Type:
Show Source
object-
comment: string
Minimum Length:
0Maximum Length:2048 -
eventId: string
-
eventInstanceNum: integer
-
formId: string
-
formSectionId: string
-
freeze: string
-
id: string
(uuid)
-
itemId: string
-
objectVersionNumber: number
-
operationType: string
-
reason: string
Minimum Length:
0Maximum Length:255 -
repeatFormNumber: integer
-
repeatSequenceNumber: integer
-
signed: string
-
softwareVersionNumber: number
-
studyVersion: string
-
subjectId: string
-
userId: string
(uuid)
-
verify: string
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
400 Response
Bad request.
Root Schema : DcsResponse
Type:
Show Source
object-
errorData: object
ErrorResponseData
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
-
result: object
result
-
status: string
-
version: integer
(int32)
Nested Schema : ErrorResponseData
Type:
objectStructure 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
Nested Schema : result
Type:
object