Jump to

• Request
• Response

v1.0

post

/ec-site-svc/rest/v1.0/organizations/validateFields

Validates organization fields present in input payload and returns the corresponding flag as either true or false.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ORGANIZATION_FIELDS_TITLE

Type: object

Title: ORGANIZATION_FIELDS_TITLE

ORGANIZATION_FIELDS_DESC

Show Source

• organizationFields: object Field
  Title: Field

  Contains field details.

{
    "title":"ORGANIZATION_FIELDS_TITLE",
    "type":"object",
    "properties":{
        "organizationFields":{
            "title":"Field",
            "type":"object",
            "properties":{
                "fieldName":{
                    "title":"Field Name",
                    "type":"string",
                    "description":"Field name. The acceptable values are: TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc.",
                    "example":"TENANTID"
                },
                "fieldValue":{
                    "title":"Field Value",
                    "type":"string",
                    "description":"Value reported for the field.",
                    "example":"TENANT123"
                },
                "valueExists":{
                    "title":"Value Exists",
                    "type":"boolean",
                    "description":"Indicates whether the value already exists.",
                    "example":true
                }
            },
            "description":"Contains field details.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ]
        }
    },
    "description":"ORGANIZATION_FIELDS_DESC"
}

Nested Schema : Field

Type: object

Title: Field

Contains field details.

Show Source

• fieldName: string
  Title: Field Name

  Field name. The acceptable values are: TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc.

  Example: TENANTID
• fieldValue: string
  Title: Field Value

  Value reported for the field.

  Example: TENANT123
• valueExists: boolean
  Title: Value Exists

  Indicates whether the value already exists.

  Example: true

{
    "title":"Field",
    "type":"object",
    "properties":{
        "fieldName":{
            "title":"Field Name",
            "type":"string",
            "description":"Field name. The acceptable values are: TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc.",
            "example":"TENANTID"
        },
        "fieldValue":{
            "title":"Field Value",
            "type":"string",
            "description":"Value reported for the field.",
            "example":"TENANT123"
        },
        "valueExists":{
            "title":"Value Exists",
            "type":"boolean",
            "description":"Indicates whether the value already exists.",
            "example":true
        }
    },
    "description":"Contains field details.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Examples

Select an example Validate Organization Fields Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested 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 : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Validate Organization Fields Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested 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 : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Bad Request Response

Back to Top