Jump to

• Request
• Response

V1.0

post

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

Returns randomization strata item data for the requested study-version visits. The request body is an array where each object identifies a study version and visit. The response is an EDC envelope whose result contains strata and their related visit item details grouped by study version.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string).

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• mode: string
  Study mode filter.

  Allowed Values: [ "test", "training", "active" ]

  Example:

  test

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Strata items were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RespStratumVisitItemsDto

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

Nested Schema : RespStratumVisitItemsDto

Type: object

Show Source

• strata: object StratumVisitDto v1.0
  Title: StratumVisitDto v1.0

  Stratum Visit Detail Information
• studyVersion: string
  Study Version

  Example: 1.0.0.1

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

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

Examples

Select an example strataItemsResponseV1

400 Response

The request payload is missing studyVersion or visitId, or contains invalid values.

Body ()

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example badRequest

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example serverError

Back to Top