Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld-history

Get dose hold history for current subject. Rights: OrsSubjectVisitGet

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:

  C36A3197FDEE433FB5547EE83DE99E4B

• subjectId(required): string(uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : KitDoseHeldHistoryTO v1.0

Type: object

Title: KitDoseHeldHistoryTO v1.0

Contains dose hold history for a kit.

Show Source

• canBeDispensed: boolean
  Indicate if the dosehold kit can be dispensed.

  Example: true
• instanceNumber: number (BigDecimal)
  Title: Instance Number

  Minimum Value: 1

  Visit instance number.

  Example: 2
• objectVersionNumber: number (BigDecimal)
  Object version number.

  Example: 5
• userId: string (uuid)
  User ID.
• versionEnd: string (date-time)
  Version end date.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.
• visitId: string (uuid)
  Title: Visit ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

{
    "title":"KitDoseHeldHistoryTO v1.0",
    "type":"object",
    "properties":{
        "visitId":{
            "title":"Visit ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        },
        "canBeDispensed":{
            "type":"boolean",
            "description":"Indicate if the dosehold kit can be dispensed.",
            "example":true
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "format":"BigDecimal",
            "example":5
        },
        "userId":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end date.",
            "format":"date-time"
        },
        "instanceNumber":{
            "title":"Instance Number",
            "minimum":1,
            "type":"number",
            "description":"Visit instance number.",
            "format":"BigDecimal",
            "example":2
        }
    },
    "description":"Contains dose hold history for a kit."
}

Examples

Select an example Dose Held History Response

400 Response

Invalid subject OR Scheduled visit with instance number OR Unscheduled visit with no instance number

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 Dose Held History Bad Request 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 Dose Held History Server Error Response

Back to Top