REST API for Clinical One Platform

Get stratum items in a study for given randomized visits and study version

post

/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/strata

Retrieves a list of study strata items of given randomized visits and study version.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

items: string
mode: string

Supported Media Types

Root Schema : schema

Type: array

Show Source

Array of: object StudyVersionVisitDtoV9

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

Nested Schema : StudyVersionVisitDtoV9

Type: object

Show Source

studyId: string (uuid)
studyTitle: string

Study name

Example: Study 03
version: string

version

Example: 1.3.0.6
versionPreviousStatus: string

Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

Previous study status

Example: TESTING
versionStatus: string

Study version status

Example: Active, not recruiting
visitId: string (uuid)

Visit GUID

{
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study name",
            "example":"Study 03"
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object StratumVisitItemsDto v1.0

Title: StratumVisitItemsDto v1.0

Stratum Visit Items Detail Information

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

Nested Schema : StratumVisitItemsDto v1.0

Type: object

Title: StratumVisitItemsDto v1.0

Stratum Visit Items Detail Information

Show Source

strata: object StratumVisitDto v1.0

Title: StratumVisitDto v1.0

Stratum Visit Detail Information
studyVersion: string

Study Version

Example: 1.0.0.1

{
    "title":"StratumVisitItemsDto v1.0",
    "type":"object",
    "properties":{
        "studyVersion":{
            "type":"string",
            "description":"Study Version",
            "example":"1.0.0.1"
        },
        "strata":{
            "title":"StratumVisitDto v1.0",
            "type":"object",
            "properties":{
                "visitId":{
                    "type":"string",
                    "description":"Visit Id",
                    "format":"uuid"
                },
                "items":{
                    "title":"StratumItemDto v1.0",
                    "type":"object",
                    "properties":{
                        "itemId":{
                            "type":"string",
                            "description":"Stratum Item Id",
                            "format":"uuid"
                        },
                        "formId":{
                            "type":"string",
                            "description":"Form Id",
                            "format":"uuid"
                        },
                        "itemRefName":{
                            "type":"string",
                            "description":"Item Ref Code",
                            "example":"TEXT"
                        },
                        "sasVariable":{
                            "type":"string",
                            "description":"SAS Variable",
                            "example":"Text"
                        }
                    },
                    "description":"Stratum Item Detail Information"
                }
            },
            "description":"Stratum Visit Detail Information"
        }
    },
    "description":"Stratum Visit Items Detail Information"
}

Nested Schema : StratumVisitDto v1.0

Type: object

Title: StratumVisitDto v1.0

Stratum Visit Detail Information

Show Source

items: object StratumItemDto v1.0

Title: StratumItemDto v1.0

Stratum Item Detail Information
visitId: string (uuid)

Visit Id

{
    "title":"StratumVisitDto v1.0",
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "description":"Visit Id",
            "format":"uuid"
        },
        "items":{
            "title":"StratumItemDto v1.0",
            "type":"object",
            "properties":{
                "itemId":{
                    "type":"string",
                    "description":"Stratum Item Id",
                    "format":"uuid"
                },
                "formId":{
                    "type":"string",
                    "description":"Form Id",
                    "format":"uuid"
                },
                "itemRefName":{
                    "type":"string",
                    "description":"Item Ref Code",
                    "example":"TEXT"
                },
                "sasVariable":{
                    "type":"string",
                    "description":"SAS Variable",
                    "example":"Text"
                }
            },
            "description":"Stratum Item Detail Information"
        }
    },
    "description":"Stratum Visit Detail Information"
}

Nested Schema : StratumItemDto v1.0

Type: object

Title: StratumItemDto v1.0

Stratum Item Detail Information

Show Source

formId: string (uuid)

Form Id
itemId: string (uuid)

Stratum Item Id
itemRefName: string

Item Ref Code

Example: TEXT
sasVariable: string

SAS Variable

Example: Text

{
    "title":"StratumItemDto v1.0",
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "description":"Stratum Item Id",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form Id",
            "format":"uuid"
        },
        "itemRefName":{
            "type":"string",
            "description":"Item Ref Code",
            "example":"TEXT"
        },
        "sasVariable":{
            "type":"string",
            "description":"SAS Variable",
            "example":"Text"
        }
    },
    "description":"Stratum Item Detail Information"
}

500 Response

Error

Root 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 : Object

Type: object

Title: Object

Object with error details information.