Jump to

• Request
• Response

v1.0

get

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

Retrieves all details of the DND Exceptions. Rights: DispensationExceptionGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  B1B8327AFAA6412287106192AB5984EF

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DNDExceptionsResponse

Type: object

Title: DNDExceptionsResponse

Response object containing list of DND exceptions.

Show Source

• dndExceptions: array dndExceptions

{
    "title":"DNDExceptionsResponse",
    "type":"object",
    "properties":{
        "dndExceptions":{
            "type":"array",
            "example":[
                {
                    "dndExceptionId":"B1B8327AFAA6412287106192AB5984EF",
                    "kitTypeSrcId":[
                        "6AF54DB79B764662B685D68C52AB0B84"
                    ],
                    "allCountries":false,
                    "countries":[
                        "US"
                    ],
                    "siteIds":[
                        "ABC8327AFAA6412287106192AB5984EF"
                    ],
                    "visitDND":[
                        {
                            "visitSrcId":"B1B8327AFAA6412287106192AB5984EF",
                            "dnd":2
                        }
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DNDExceptionListResponse"
            }
        }
    },
    "description":"Response object containing list of DND exceptions."
}

Nested Schema : dndExceptions

Type: array

Show Source

• Array of: object DNDExceptionListResponse
  Title: DNDExceptionListResponse

  Response object containing DND exceptions details.

{
    "type":"array",
    "example":[
        {
            "dndExceptionId":"B1B8327AFAA6412287106192AB5984EF",
            "kitTypeSrcId":[
                "6AF54DB79B764662B685D68C52AB0B84"
            ],
            "allCountries":false,
            "countries":[
                "US"
            ],
            "siteIds":[
                "ABC8327AFAA6412287106192AB5984EF"
            ],
            "visitDND":[
                {
                    "visitSrcId":"B1B8327AFAA6412287106192AB5984EF",
                    "dnd":2
                }
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DNDExceptionListResponse"
    }
}

Example:

[
    {
        "dndExceptionId":"B1B8327AFAA6412287106192AB5984EF",
        "kitTypeSrcId":[
            "6AF54DB79B764662B685D68C52AB0B84"
        ],
        "allCountries":false,
        "countries":[
            "US"
        ],
        "siteIds":[
            "ABC8327AFAA6412287106192AB5984EF"
        ],
        "visitDND":[
            {
                "visitSrcId":"B1B8327AFAA6412287106192AB5984EF",
                "dnd":2
            }
        ]
    }
]

Nested Schema : DNDExceptionListResponse

Type: object

Title: DNDExceptionListResponse

Response object containing DND exceptions details.

Show Source

• allCountries: boolean
  Title: All Countries

  Indicates whether the exception applies to all countries.

  Example: true
• countries: array Countries
  Title: Countries

  Unique Items Required: true

  ISO codes of countries.
• dndExceptionId: string (uuid)
  Title: DND Exception ID

  Do Not Dispense exception identifier.
• kitTypeSrcId: array Kit Type Source IDs
  Title: Kit Type Source IDs

  Unique Items Required: true

  List of kit type source IDs.
• siteIds: array Site IDs
  Title: Site IDs

  Unique Items Required: true

  List of site IDs.
• visitDND: array visitDND

{
    "title":"DNDExceptionListResponse",
    "type":"object",
    "properties":{
        "dndExceptionId":{
            "title":"DND Exception ID",
            "type":"string",
            "description":"Do Not Dispense exception identifier.",
            "format":"uuid"
        },
        "kitTypeSrcId":{
            "title":"Kit Type Source IDs",
            "uniqueItems":true,
            "type":"array",
            "description":"List of kit type source IDs.",
            "example":[
                "B1B8327AFAA6412287106192AB5984EF",
                "ABC8327AFAA6412287106192AB5984EF"
            ],
            "items":{
                "title":"Kit Type Source IDs",
                "type":"string",
                "description":"List of kit type source IDs.",
                "example":"[\"B1B8327AFAA6412287106192AB5984EF\",\"ABC8327AFAA6412287106192AB5984EF\"]"
            }
        },
        "allCountries":{
            "title":"All Countries",
            "type":"boolean",
            "description":"Indicates whether the exception applies to all countries.",
            "example":true
        },
        "countries":{
            "title":"Countries",
            "uniqueItems":true,
            "type":"array",
            "description":"ISO codes of countries.",
            "example":[
                "IN",
                "US"
            ],
            "items":{
                "title":"Countries",
                "type":"string",
                "description":"ISO codes of countries.",
                "example":"[\"IN\",\"US\"]"
            }
        },
        "siteIds":{
            "title":"Site IDs",
            "uniqueItems":true,
            "type":"array",
            "description":"List of site IDs.",
            "example":[
                "B1B8327AFAA6412287106192AB5984EF",
                "ABC8327AFAA6412287106192AB5984EF"
            ],
            "items":{
                "title":"Site IDs",
                "type":"string",
                "description":"List of site IDs.",
                "example":"[\"B1B8327AFAA6412287106192AB5984EF\",\"ABC8327AFAA6412287106192AB5984EF\"]"
            }
        },
        "visitDND":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitDNDV1"
            }
        }
    },
    "description":"Response object containing DND exceptions details."
}

Nested Schema : Countries

Type: array

Title: Countries

Unique Items Required: true

ISO codes of countries.

Show Source

• Array of: string
  Title: Countries

  ISO codes of countries.

  Example: ["IN","US"]

{
    "title":"Countries",
    "uniqueItems":true,
    "type":"array",
    "description":"ISO codes of countries.",
    "example":[
        "IN",
        "US"
    ],
    "items":{
        "title":"Countries",
        "type":"string",
        "description":"ISO codes of countries.",
        "example":"[\"IN\",\"US\"]"
    }
}

Example:

[
    "IN",
    "US"
]

Nested Schema : Kit Type Source IDs

Type: array

Title: Kit Type Source IDs

Unique Items Required: true

List of kit type source IDs.

Show Source

• Array of: string
  Title: Kit Type Source IDs

  List of kit type source IDs.

  Example: ["B1B8327AFAA6412287106192AB5984EF","ABC8327AFAA6412287106192AB5984EF"]

{
    "title":"Kit Type Source IDs",
    "uniqueItems":true,
    "type":"array",
    "description":"List of kit type source IDs.",
    "example":[
        "B1B8327AFAA6412287106192AB5984EF",
        "ABC8327AFAA6412287106192AB5984EF"
    ],
    "items":{
        "title":"Kit Type Source IDs",
        "type":"string",
        "description":"List of kit type source IDs.",
        "example":"[\"B1B8327AFAA6412287106192AB5984EF\",\"ABC8327AFAA6412287106192AB5984EF\"]"
    }
}

Example:

[
    "B1B8327AFAA6412287106192AB5984EF",
    "ABC8327AFAA6412287106192AB5984EF"
]

Nested Schema : Site IDs

Type: array

Title: Site IDs

Unique Items Required: true

List of site IDs.

Show Source

• Array of: string
  Title: Site IDs

  List of site IDs.

  Example: ["B1B8327AFAA6412287106192AB5984EF","ABC8327AFAA6412287106192AB5984EF"]

{
    "title":"Site IDs",
    "uniqueItems":true,
    "type":"array",
    "description":"List of site IDs.",
    "example":[
        "B1B8327AFAA6412287106192AB5984EF",
        "ABC8327AFAA6412287106192AB5984EF"
    ],
    "items":{
        "title":"Site IDs",
        "type":"string",
        "description":"List of site IDs.",
        "example":"[\"B1B8327AFAA6412287106192AB5984EF\",\"ABC8327AFAA6412287106192AB5984EF\"]"
    }
}

Example:

[
    "B1B8327AFAA6412287106192AB5984EF",
    "ABC8327AFAA6412287106192AB5984EF"
]

Nested Schema : visitDND

Type: array

Show Source

• Array of: object VisitDND v1.0
  Title: VisitDND v1.0

  Request to create a new VisitDND.

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

Nested Schema : VisitDND v1.0

Type: object

Title: VisitDND v1.0

Request to create a new VisitDND.

Show Source

• dnd(required): number (BigDecimal)
  Title: DND

  Minimum Value: 0

  Minimum Value: > false

  Maximum Value: 99999

  Maximum Value: < false

  Do not dispense value.

  Example: 2
• visitSrcId(required): string (uuid)
  Title: Visit Source ID

  Visit source identifier.

{
    "title":"VisitDND v1.0",
    "required":[
        "dnd",
        "visitSrcId"
    ],
    "type":"object",
    "properties":{
        "visitSrcId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Visit source identifier.",
            "format":"uuid"
        },
        "dnd":{
            "title":"DND",
            "maximum":99999,
            "exclusiveMaximum":false,
            "minimum":0,
            "exclusiveMinimum":false,
            "type":"number",
            "description":"Do not dispense value.",
            "format":"BigDecimal",
            "example":2
        }
    },
    "description":"Request to create a new VisitDND."
}

Examples

Select an example Get DND Exceptions Response

400 Response

Dispensation logic (dynamic DND) request is not valid

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Get DND Exceptions Bad Request Response

404 Response

Invalid study ID or version

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Get DND Exceptions Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Get DND Exceptions Server Error Response

Back to Top