Jump to

• Request
• Response

[Deprecated]: V3.0

delete

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

Deprecated: Use latest version instead. Removes selected forms from a visit or removes all forms when payload is omitted.

Request

Path Parameters

• 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

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

  Example:

  9F4A6C7E1B8F4D56A23C9F3A0C7D4E77

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: string

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

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VisitFormDto v3.0
  Title: VisitFormDto v3.0

  Visit design forms.

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

Nested Schema : VisitFormDto v3.0

Type: object

Title: VisitFormDto v3.0

Visit design forms.

Show Source

• fields: integer (int32)
  Number of form's fields

  Example: 5
• formId: string (uuid)
  Visit Design form GUID
• formTitle: string
  Form title

  Example: Demography

{
    "title":"VisitFormDto v3.0",
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Visit Design form GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "fields":{
            "type":"integer",
            "description":"Number of form's fields",
            "format":"int32",
            "example":5
        }
    },
    "description":"Visit design forms."
}

Examples

Select an example removeVisitFormsV3Response

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