REST API for Clinical One Platform

~~[Deprecated]: Get list of visits status for subjects~~

post

/ec-dc-svc/rest/v13.0/studies/{studyId}/{mode}/visitstatus/subjects

Deprecated: Retrieves a list of visits status for subjects, as well as the study version associated with each visit status. This API request also lists unscheduled event details.Now supports query param cycleCountToDate for filtering by scheduled date for cycles

Request

Path Parameters

studyId(required): string

ID of the study for which you want to get the list of subjects.

Query Parameters

cycleCountToDate: string(date-time)
nextVisitOnly: boolean
notStarted: boolean
signVerifyStatus(required): string

Status of Sign / Verify.

Default Value: ALL
siteId: string
siteStudyVersion: string

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

subjects: array subjects

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : subjects

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object SubjectVisitsDto90

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

Nested Schema : SubjectVisitsDto90

Type: object

Show Source

canBeCompleted: boolean
crntStateStudyVrsn: string
freezedStatus: string
lastSigned: string
lockedInStudyVersion: string
lockedStatus: string
scheduledVisits: array scheduledVisits
signedStatus: string
subjectId: string
verifiedStatus: string
visits: array visits

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitsStatusDto12"
            }
        },
        "scheduledVisits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduledVisitsDto"
            }
        },
        "crntStateStudyVrsn":{
            "type":"string"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "lastSigned":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "canBeCompleted":{
            "type":"boolean"
        },
        "lockedInStudyVersion":{
            "type":"string"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

Show Source

Array of: object ScheduledVisitsDto

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

Nested Schema : visits

Type: array

Show Source

Array of: object VisitsStatusDto12

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

Nested Schema : ScheduledVisitsDto

Type: object

Show Source

cycleCount: number
eventId: string
eventInstanceNum: number
scheduledDate: string (date-time)
scheduledWindowEndDate: string (date-time)
scheduledWindowStartDate: string (date-time)
title: string

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "eventInstanceNum":{
            "type":"number"
        },
        "cycleCount":{
            "type":"number"
        }
    }
}

Nested Schema : VisitsStatusDto12

Type: object

Show Source

associatedStudyVersion: string
comment: string

Minimum Length: 0

Maximum Length: 2048
eventId: string
eventInstanceNum: integer (int32)
eventType: string
freezedStatus: string
id: string (uuid)
lockedDateTime: string (date-time)
lockedStatus: string
objectVersionNumber: number
operationType: string
reason: string

Minimum Length: 0

Maximum Length: 255
repeatingFormCount: number
scheduledWindowEndDate: string (date-time)
scheduledWindowStartDate: string (date-time)
signedStatus: string
siteId: string
softwareVersionNumber: number
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string
userId: string (uuid)
verifiedStatus: string
versionEnd: string (date-time)
versionStart: string (date-time)
visitAction: string
visitStartDate: string (date-time)
visitStartDateLockedDateTime: string (date-time)
visitStartDateLockedStatus: string
visitStatus: string
visitType: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "visitStatus":{
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "repeatingFormCount":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "associatedStudyVersion":{
            "type":"string"
        },
        "visitAction":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "visitStartDateLockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

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

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.