Jump to

• Request
• Response

Validate fields for Study Labs/Depots/Sites

post

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/validateFields

Validate Study Labs/Depots/Sites fields present in input payload and returns the corresponding flag as true or false.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• sdfType(required): string
  Type of SDF : Sites or Depots.
• studyId(required): string(uuid)
  The ID of the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• sdfFields: array sdfFields

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

Nested Schema : sdfFields

Type: array

Show Source

• Array of: object FieldDto

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

Nested Schema : FieldDto

Type: object

Show Source

• fieldName: string
• fieldValue: string
• valueExists: boolean

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string"
        },
        "fieldValue":{
            "type":"string"
        },
        "valueExists":{
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

400 Response

Bad request.

Body ()

Root Schema : SDFResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "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

Back to Top