REST API for Clinical One Platform

Create DND exception

post

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

Creates a DND exception. Rights Needed : DispensatonExceptionPost.

Request

Path Parameters

mode(required): string

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

ID of the study

Supported Media Types

application/json

Root Schema : DNDExceptionRequest

Type: object

Title: DNDExceptionRequest

Request to create a new DND exception

Show Source

allCountries(required): boolean

Set to True to enable DND exception to All countries in the study

Example: true
countries: array countries

Contains ISO codes of countries .
kitTypeSrcId(required): array kitTypeSrcId

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

List of kitTypeSrcIdS
siteIds: array siteIds

Unique Items Required: true

List of siteids
visitDND(required): array visitDND

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

{
    "title":"DNDExceptionRequest",
    "required":[
        "allCountries",
        "kitTypeSrcId",
        "visitDND"
    ],
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "maxItems":2147483647,
            "minItems":1,
            "uniqueItems":true,
            "type":"array",
            "description":"List of kitTypeSrcIdS",
            "example":[
                "6AF54DB79B764662B685D68C52AB0B84",
                "6AF54DB79B764662B685D68C52AB0B84"
            ],
            "items":{
                "type":"string",
                "description":"List of kitTypeSrcIdS",
                "format":"uuid"
            }
        },
        "allCountries":{
            "type":"boolean",
            "description":"Set to True to enable DND exception to All countries in the study",
            "example":true
        },
        "countries":{
            "type":"array",
            "description":"Contains ISO codes of countries .",
            "items":{
                "type":"string",
                "format":"String",
                "example":"US"
            }
        },
        "visitDND":{
            "maxItems":2147483647,
            "minItems":1,
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitDND"
            }
        },
        "siteIds":{
            "uniqueItems":true,
            "type":"array",
            "description":"List of siteids",
            "example":[
                "6AF54DB79B764662B685D68C52AB0B84",
                "6AF54DB79B764662B685D68C52AB0B84"
            ],
            "items":{
                "type":"string",
                "description":"List of siteids",
                "format":"uuid"
            }
        }
    },
    "description":"Request to create a new DND exception"
}

Nested Schema : countries

Type: array

Contains ISO codes of countries .

Show Source

Array of: string(String)

Example: US

{
    "type":"array",
    "description":"Contains ISO codes of countries .",
    "items":{
        "type":"string",
        "format":"String",
        "example":"US"
    }
}

Nested Schema : kitTypeSrcId

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

List of kitTypeSrcIdS

Show Source

Array of: string(uuid)

List of kitTypeSrcIdS

{
    "maxItems":2147483647,
    "minItems":1,
    "uniqueItems":true,
    "type":"array",
    "description":"List of kitTypeSrcIdS",
    "example":[
        "6AF54DB79B764662B685D68C52AB0B84",
        "6AF54DB79B764662B685D68C52AB0B84"
    ],
    "items":{
        "type":"string",
        "description":"List of kitTypeSrcIdS",
        "format":"uuid"
    }
}

Example:

[
    "6AF54DB79B764662B685D68C52AB0B84",
    "6AF54DB79B764662B685D68C52AB0B84"
]

Nested Schema : siteIds

Type: array

Unique Items Required: true

List of siteids

Show Source

Array of: string(uuid)

List of siteids

{
    "uniqueItems":true,
    "type":"array",
    "description":"List of siteids",
    "example":[
        "6AF54DB79B764662B685D68C52AB0B84",
        "6AF54DB79B764662B685D68C52AB0B84"
    ],
    "items":{
        "type":"string",
        "description":"List of siteids",
        "format":"uuid"
    }
}

Example:

[
    "6AF54DB79B764662B685D68C52AB0B84",
    "6AF54DB79B764662B685D68C52AB0B84"
]

Nested Schema : visitDND

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

Show Source

Array of: object VisitDND

Title: VisitDND

Request to create a new VisitDND

{
    "maxItems":2147483647,
    "minItems":1,
    "uniqueItems":true,
    "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"
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : IDResponse

Type: object

Response object containing Id.

Show Source

id: string (uuid)

Id

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id",
            "format":"uuid"
        }
    },
    "description":"Response object containing Id."
}

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.