REST API for Clinical One Platform

Get all DND exceptions

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception

Retrieves all details of the DND exception. Rights: DispensationExceptionGet

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : DNDExceptionsResponse

Type: object

Response object containing List of dndExceptions.

Show Source

dndExceptions: array dndExceptions

{
    "type":"object",
    "properties":{
        "dndExceptions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DNDExceptionListResponse"
            }
        }
    },
    "description":"Response object containing List of dndExceptions."
}

Nested Schema : dndExceptions

Type: array

Show Source

Array of: object DNDExceptionListResponse

Response object containing dndExceptions details

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

Nested Schema : DNDExceptionListResponse

Type: object

Response object containing dndExceptions details

Show Source

allCountries: boolean

Example: true
countries: array countries

Unique Items Required: true

List of countries
dndExceptionId: string (uuid)

dndException Id
kitTypeSrcId: array kitTypeSrcId

Unique Items Required: true

List of sites
visitDND: array visitDND

{
    "type":"object",
    "properties":{
        "dndExceptionId":{
            "type":"string",
            "description":"dndException Id",
            "format":"uuid"
        },
        "kitTypeSrcId":{
            "uniqueItems":true,
            "type":"array",
            "description":"List of sites",
            "example":[
                "B1B8327AFAA6412287106192AB5984EF",
                "ABC8327AFAA6412287106192AB5984EF"
            ],
            "items":{
                "type":"string",
                "description":"List of sites",
                "example":"[\"B1B8327AFAA6412287106192AB5984EF\",\"ABC8327AFAA6412287106192AB5984EF\"]"
            }
        },
        "allCountries":{
            "type":"boolean",
            "example":true
        },
        "countries":{
            "uniqueItems":true,
            "type":"array",
            "description":"List of countries",
            "example":[
                "IN",
                "US"
            ],
            "items":{
                "type":"string",
                "description":"List of countries",
                "example":"[\"IN\",\"US\"]"
            }
        },
        "visitDND":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitDND"
            }
        }
    },
    "description":"Response object containing dndExceptions details"
}

Nested Schema : countries

Type: array

Unique Items Required: true

List of countries

Show Source

Array of: string

List of countries

Example: ["IN","US"]

{
    "uniqueItems":true,
    "type":"array",
    "description":"List of countries",
    "example":[
        "IN",
        "US"
    ],
    "items":{
        "type":"string",
        "description":"List of countries",
        "example":"[\"IN\",\"US\"]"
    }
}

Example:

[
    "IN",
    "US"
]

Nested Schema : kitTypeSrcId

Type: array

Unique Items Required: true

List of sites

Show Source

Array of: string

List of sites

Example: ["B1B8327AFAA6412287106192AB5984EF","ABC8327AFAA6412287106192AB5984EF"]

{
    "uniqueItems":true,
    "type":"array",
    "description":"List of sites",
    "example":[
        "B1B8327AFAA6412287106192AB5984EF",
        "ABC8327AFAA6412287106192AB5984EF"
    ],
    "items":{
        "type":"string",
        "description":"List of sites",
        "example":"[\"B1B8327AFAA6412287106192AB5984EF\",\"ABC8327AFAA6412287106192AB5984EF\"]"
    }
}

Example:

[
    "B1B8327AFAA6412287106192AB5984EF",
    "ABC8327AFAA6412287106192AB5984EF"
]

Nested Schema : visitDND

Type: array

Show Source

Array of: object VisitDND

Title: VisitDND

Request to create a new VisitDND

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

Nested Schema : VisitDND

Type: object

Title: VisitDND

Request to create a new VisitDND

Show Source

dnd(required): number (BigDecimal)

Minimum Value: 0

Minimum Value: > false

Maximum Value: 99999

Maximum Value: < false

dnd

Example: 2
visitSrcId(required): string (uuid)

visitSrcId of the visit

{
    "title":"VisitDND",
    "required":[
        "dnd",
        "visitSrcId"
    ],
    "type":"object",
    "properties":{
        "visitSrcId":{
            "type":"string",
            "description":"visitSrcId of the visit",
            "format":"uuid"
        },
        "dnd":{
            "maximum":99999,
            "exclusiveMaximum":false,
            "minimum":0,
            "exclusiveMinimum":false,
            "type":"number",
            "description":"dnd",
            "format":"BigDecimal",
            "example":2
        }
    },
    "description":"Request to create a new VisitDND"
}

400 Response

Dispensation Logic (Dynamic DND) Request is not valid

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

404 Response

For Invalid study ID or version

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.