REST API for Clinical One Platform

Get list of visit statuses for the given entries

post

/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/multiple

Retrieves the list of visits statuses for a given set of entries that include Subject and Event IDs (Designer visit ID). It uses VisitStatusDto12 that includes the locked status of the visit and visit start date besides other data included in VisitStatusDto11.

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.

Supported Media Types

Root Schema : schema

Type: object

Show Source

visitDetails: array visitDetails

{
    "type":"object",
    "properties":{
        "visitDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitDetails"
            }
        }
    }
}

Nested Schema : visitDetails

Type: array

Show Source

Array of: object VisitDetails

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

Nested Schema : VisitDetails

Type: object

Show Source

eventId: string
subjectId: string

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : schema

Type: array

Show Source

Array of: object VisitsStatus

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

Nested Schema : VisitsStatus

Type: object

Show Source

associatedStudyVersion: string

Minimum Length: 0

Maximum Length: 100
comment: string

Minimum Length: 0

Maximum Length: 2048
display: string
doseHoldAction: string
dynamicAllCycles: string
eventId: string
eventInstanceNum: integer (int32)
eventType: string
freezedStatus: string
id: string (uuid)
leadingDataelementId: string
lockedDateTime: string (date-time)
lockedStatus: string
operationType: string

Minimum Length: 1

Maximum Length: 16
reason: string

Minimum Length: 0

Maximum Length: 255
repeatingFormCount: number
scheduledDate: string (date-time)
scheduledEndDate: string (date-time)
scheduledFromEventGUID: string
scheduledStartDate: string (date-time)
scheduledWindowEndDate: string (date-time)
scheduledWindowStartDate: string (date-time)
signedStatus: string
siteId: string
studyVersion(required): string

Minimum Length: 0

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

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "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"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "associatedStudyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "leadingDataelementId":{
            "type":"string"
        },
        "dynamicAllCycles":{
            "type":"string"
        },
        "visitWindowWarning":{
            "type":"string"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledFromEventGUID":{
            "type":"string"
        },
        "repeatingFormCount":{
            "type":"number"
        },
        "signedStatus":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "visitStartDateLockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "doseHoldAction":{
            "type":"string"
        },
        "visitAction":{
            "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