REST API for Clinical One Platform

Create request for multiple locked visits summary

post

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/validate/multiplevisits

Provides the summary for the multiple visits and returns the actions of visit and visitStartDate.

Request

Path Parameters

mode(required): string

Mode to fetch the record for
studyId(required): string

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

Subject ID to fetch the record for

Supported Media Types

Root Schema : schema

Type: object

Show Source

visits: array visits

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

Nested Schema : visits

Type: array

Show Source

Array of: object VisitsDTO

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

Nested Schema : VisitsDTO

Type: object

Show Source

eventId: string (uuid)
eventInstanceNum: integer

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNum":{
            "type":"integer"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: boolean

{
    "type":"array",
    "items":{
        "type":"boolean"
    }
}

400 Response

Bad request.

Root Schema : RestResponse

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