Create a DNDException
post
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception
Creates a DNDException. 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 DNDException
Show Source
-
allCountries(required): boolean
Set to True to enable DNDException to All countries in the studyExample:
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
Nested Schema : countries
Type:
array
Contains ISO codes of countries .
Show Source
-
Array of:
string(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
Example:
[
"6AF54DB79B764662B685D68C52AB0B84",
"6AF54DB79B764662B685D68C52AB0B84"
]
Nested Schema : siteIds
Type:
array
Unique Items Required:
true
List of siteids
Show Source
-
Array of:
string(uuid)
List of siteids
Example:
[
"6AF54DB79B764662B685D68C52AB0B84",
"6AF54DB79B764662B685D68C52AB0B84"
]
Nested Schema : visitDND
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
2147483647
Unique Items Required:
Show Source
true
-
Array of:
object VisitDND
Title:
VisitDND
Request to create a new 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
dndExample:2
-
visitSrcId(required): string
(uuid)
visitSrcId of the visit
Response
Supported Media Types
- application/json
200 Response
Successful operation
400 Response
Dispensation Logic (Dynamic DND) Request is not valid
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
For Invalid study ID or version
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object