Jump to

• Request
• Response

V10.0

post

/ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}/visits

Processes visits to be associated with a specific form in a study.

Request

Path Parameters

• formId(required): string(uuid)
  Form ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

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

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object From Item Advanced Property v10.0
  Title: From Item Advanced Property v10.0

  Form Item Advanced Property

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

Nested Schema : From Item Advanced Property v10.0

Type: object

Title: From Item Advanced Property v10.0

Form Item Advanced Property

Show Source

• id: string (uuid)
  Extended Property ID
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
• value(required): string
  Minimum Length: 1

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v10.0",
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov10"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object From Item Advanced Property Rule v10.0
  Title: From Item Advanced Property Rule v10.0

  Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v10.0

Type: object

Title: From Item Advanced Property Rule v10.0

Form Item Advanced Property Rule

Show Source

• label: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

  Example: Yes
• name: string
  name

  Example: RolloverQuestionAnswer
• value: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v10.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Examples

Select an example processFormVisitsV10Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Examples

Select an example processFormVisitsV10Response

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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top