REST API for Clinical One Platform

v1.0 REST Endpoints

Data Capture/Subjects/v1.0

The operations from the Data Capture/Subjects/v1.0 category.

Get all subject Numbers for a Site, it does not check if site has any study version associated.: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/screeningnumber
~~[Deprecated]: Add a subject~~: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects
~~[Deprecated]: Get a list of events by type~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/events
~~[Deprecated]: Get a list of subjects for the specified study and mode~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects
~~[Deprecated]: Get Clinical Data which is part of ODMSubmit~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}
~~[Deprecated]: Get details for a subject~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}
~~[Deprecated]: Get information for a transfer ID~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/{transferId}
~~[Deprecated]: Get latest records for sign, verify and freeze~~: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/svf
~~[Deprecated]: Get transfer records for a subject for a date range~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}
~~[Deprecated]: Get Visits MetaData which is part of ODMSubmit~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/visitsMetadata/{subjectId}
~~[Deprecated]: Sign subject and visits~~: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
~~[Deprecated]: Update subject details~~: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: Update subject number: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/subjectnumber
Check status of study randomization limit or restriction: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randrestricted
Check the study randomization limit: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randlimitexceeded
~~Code view on a subject~~: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
Create a subject transfer: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers
Enroll a subject: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/enroll
Get a list of subject numbers: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/numberstatus
Get a list of subject-related values: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/lov/{pathAttr}
~~Get a subject's events within a date range~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
~~Get all subjects for a specific study version~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sitestudyversion
Get events within a date range: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/dateRange
~~Get history for a specific subject~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get last added subject number: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/availableSubjectNumbers
Get latest audit records for Source Data Verification: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sdvselected
~~Get latest audit records for visit verification~~: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify/history
Get OrgId used to generate subject number: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/orgid
Get source data verification selection status for all subjects: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/selectionStatus/{siteId}
Get Subject count: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/count
~~Get subjects and their visit schedule~~: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/visitschedule
~~Get the history of all subjects in a mode~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/history/all
~~Get transfer records for a study~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers
~~Get transfer records for a subject~~: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
List all subjects for the study and mode: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/idsforsitestudyversion
~~Migrate a subject~~: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/migratesubject
~~Perform code break on a subject~~: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
~~Randomize or dispense subject~~: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randomizeordispense
Register subject to mHealth: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/mhealthRegister
Undo the Added subject from a study: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/undoSubject
Undo the latest operation applied to the subject: Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/state/{subjectId}
~~Update randNumber~~: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/randomizationnumber/{randNumber}
Update subject numbers: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/subjectnumber