Jump to

• Request
• Response

v1.0

post

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

Creates a DND Exception. Rights needed: DispensationExceptionPost.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : DNDExceptionRequest v1.0

Type: object

Title: DNDExceptionRequest v1.0

Request to create a new DNDException.

Show Source

• allCountries(required): boolean
  Title: All Countries

  Indicates whether the exception applies to all countries.

  Example: true
• countries: array Countries
  Title: Countries

  ISO codes of countries.
• kitTypeSrcId(required): array Kit Type Source IDs
  Title: Kit Type Source IDs

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  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(required): array visitDND
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Unique Items Required: true

{
    "title":"DNDExceptionRequest v1.0",
    "required":[
        "allCountries",
        "kitTypeSrcId",
        "visitDND"
    ],
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "title":"Kit Type Source IDs",
            "maxItems":2147483647,
            "minItems":1,
            "uniqueItems":true,
            "type":"array",
            "description":"List of kit type source IDs.",
            "example":[
                "6AF54DB79B764662B685D68C52AB0B84",
                "6AF54DB79B764662B685D68C52AB0B84"
            ],
            "items":{
                "title":"Kit Type Source IDs",
                "type":"string",
                "description":"List of kit type source IDs.",
                "format":"uuid"
            }
        },
        "allCountries":{
            "title":"All Countries",
            "type":"boolean",
            "description":"Indicates whether the exception applies to all countries.",
            "example":true
        },
        "countries":{
            "title":"Countries",
            "type":"array",
            "description":"ISO codes of countries.",
            "items":{
                "type":"string",
                "format":"String",
                "example":"US"
            }
        },
        "visitDND":{
            "maxItems":2147483647,
            "minItems":1,
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitDNDV1"
            }
        },
        "siteIds":{
            "title":"Site IDs",
            "uniqueItems":true,
            "type":"array",
            "description":"List of site IDs.",
            "example":[
                "6AF54DB79B764662B685D68C52AB0B84",
                "6AF54DB79B764662B685D68C52AB0B84"
            ],
            "items":{
                "title":"Site IDs",
                "type":"string",
                "description":"List of site IDs.",
                "format":"uuid"
            }
        }
    },
    "description":"Request to create a new DNDException."
}

Nested Schema : Countries

Type: array

Title: Countries

ISO codes of countries.

Show Source

• Array of: string(String)
  Example: US

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

Nested Schema : Kit Type Source IDs

Type: array

Title: Kit Type Source IDs

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

List of kit type source IDs.

Show Source

• Array of: string(uuid)
  Title: Kit Type Source IDs

  List of kit type source IDs.

{
    "title":"Kit Type Source IDs",
    "maxItems":2147483647,
    "minItems":1,
    "uniqueItems":true,
    "type":"array",
    "description":"List of kit type source IDs.",
    "example":[
        "6AF54DB79B764662B685D68C52AB0B84",
        "6AF54DB79B764662B685D68C52AB0B84"
    ],
    "items":{
        "title":"Kit Type Source IDs",
        "type":"string",
        "description":"List of kit type source IDs.",
        "format":"uuid"
    }
}

Example:

[
    "6AF54DB79B764662B685D68C52AB0B84",
    "6AF54DB79B764662B685D68C52AB0B84"
]

Nested Schema : Site IDs

Type: array

Title: Site IDs

Unique Items Required: true

List of site IDs.

Show Source

• Array of: string(uuid)
  Title: Site IDs

  List of site IDs.

{
    "title":"Site IDs",
    "uniqueItems":true,
    "type":"array",
    "description":"List of site IDs.",
    "example":[
        "6AF54DB79B764662B685D68C52AB0B84",
        "6AF54DB79B764662B685D68C52AB0B84"
    ],
    "items":{
        "title":"Site IDs",
        "type":"string",
        "description":"List of site IDs.",
        "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 v1.0
  Title: VisitDND v1.0

  Request to create a new VisitDND.

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : IDResponse v1.0

Type: object

Title: IDResponse v1.0

Response containing the identifier.

Show Source

• id: string (uuid)
  ID

{
    "title":"IDResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        }
    },
    "description":"Response containing the identifier."
}

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

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

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

Back to Top