Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-disp-history

Retrieves history of unblinded dispensation for a subject within the study. Rights: OrsSubjectVisitGet.

Request

Path Parameters

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

  Example:

  test

• srcSubjectId(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

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Query Parameters

• visitId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

  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 : UnblindedDispensationHistoryDTO

Type: object

Title: UnblindedDispensationHistoryDTO

Contains unblinded dispensation history.

Show Source

• kitTypes: array kitTypes

{
    "title":"UnblindedDispensationHistoryDTO",
    "type":"object",
    "properties":{
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitTypeDetailsDTO"
            }
        }
    },
    "description":"Contains unblinded dispensation history."
}

Nested Schema : kitTypes

Type: array

Show Source

• Array of: object Kit Type Details
  Title: Kit Type Details

  Contains kit type details.

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

Nested Schema : Kit Type Details

Type: object

Title: Kit Type Details

Contains kit type details.

Show Source

• description: string
  Kit type description.

  Example: Kit A
• dispensationDetails: array dispensationDetails
• id: string (uuid)
  ID of the kit type.
• kitTypeName: string
  Kit type name.

  Example: Kit A
• packageType: string
  Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

  Package type.

  Example: INHALER
• packageTypeId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

  Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

  Example: 2

{
    "title":"Kit Type Details",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "dispensationDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDispensationDTO"
            }
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "description":{
            "type":"string",
            "description":"Kit type description.",
            "example":"Kit A"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":2,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "packageType":{
            "type":"string",
            "description":"Package type.",
            "example":"INHALER",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        }
    },
    "description":"Contains kit type details.",
    "example":{
        "kitTypeId":"01A9B3C7D5E84F2AA3B4C5D6E7F80910",
        "kitTypeName":"Dose Kit"
    }
}

Example:

{
    "kitTypeId":"01A9B3C7D5E84F2AA3B4C5D6E7F80910",
    "kitTypeName":"Dose Kit"
}

Nested Schema : dispensationDetails

Type: array

Show Source

• Array of: object Kit Dispensation
  Title: Kit Dispensation

  Contains kit dispensation details.

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

Nested Schema : Kit Dispensation

Type: object

Title: Kit Dispensation

Contains kit dispensation details.

Show Source

• dispensationDate: string (date-time)
  Dispensation date.
• inventoryStatus: number (double)
  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 5
• kitNumber: number (double)
  Kit number.

  Example: 5

{
    "title":"Kit Dispensation",
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":5
        },
        "inventoryStatus":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"double",
            "example":5
        },
        "dispensationDate":{
            "type":"string",
            "description":"Dispensation date.",
            "format":"date-time"
        }
    },
    "description":"Contains kit dispensation details."
}

Examples

Select an example Unblinded Dispensation History By Subject Response

400 Response

Invalid parameters

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 Unblinded Dispensation History Bad Request Response

404 Response

Invalid study ID or version. Or subject not found

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 Unblinded Dispensation History 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 Unblinded Dispensation History Server Error Response

Back to Top