Jump to

• Request
• Response

v1.0

get

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

Retrieves dispensation info of the most recent dispensation or all previous dispensations for a study by subject and visit ID. Rights: OrsUnblinded.

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

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

Query Parameters

• dispensationInfo(required): string
  Dispensation info required [last/previous]

  Example:

  true

• includeReplacementVisits: string
  Include replacement visits [Y/N]
• includeUnScheduledVisits: string
  Include unscheduled visits [Y/N]
• instanceNumber: number
  Instance number for unscheduled visit.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DispensationInfoResponse
  Title: DispensationInfoResponse

  Response object containing dispensation information for a subject visit.

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

Nested Schema : DispensationInfoResponse

Type: object

Title: DispensationInfoResponse

Response object containing dispensation information for a subject visit.

Show Source

• dateDispensed: string (date-time)
  Title: Dispensation Date

  Dispensation date.
• dosage: number (double)
  Title: Dosage

  Dosage.

  Example: 0.5
• eventInstanceNumber: number (double)
  Title: Instance Number

  Visit instance number.

  Example: 2
• isHeld: boolean
  Title: Dose Held

  Indicates whether dose hold is applied.

  Example: false
• kitDescription: string
  Title: Kit Description

  Kit description.

  Example: Kit A description paracetamol 5mg
• kitType: string
  Title: Kit Type

  Kit type.

  Example: KitA
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• quantity: number (double)
  Title: Quantity

  Kit quantity.

  Example: 3
• visitName: string
  Title: Visit Name

  Visit name.

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

  Visit source identifier.

{
    "title":"DispensationInfoResponse",
    "type":"object",
    "properties":{
        "visitSrcId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Visit source identifier.",
            "format":"uuid"
        },
        "visitName":{
            "title":"Visit Name",
            "type":"string",
            "description":"Visit name.",
            "example":"Week1"
        },
        "eventInstanceNumber":{
            "title":"Instance Number",
            "type":"number",
            "description":"Visit instance number.",
            "format":"double",
            "example":2
        },
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "kitType":{
            "title":"Kit Type",
            "type":"string",
            "description":"Kit type.",
            "example":"KitA"
        },
        "kitDescription":{
            "title":"Kit Description",
            "type":"string",
            "description":"Kit description.",
            "example":"Kit A description paracetamol 5mg"
        },
        "dateDispensed":{
            "title":"Dispensation Date",
            "type":"string",
            "description":"Dispensation date.",
            "format":"date-time"
        },
        "dosage":{
            "title":"Dosage",
            "type":"number",
            "description":"Dosage.",
            "format":"double",
            "example":0.5
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity.",
            "format":"double",
            "example":3
        },
        "isHeld":{
            "title":"Dose Held",
            "type":"boolean",
            "description":"Indicates whether dose hold is applied.",
            "example":false
        }
    },
    "description":"Response object containing dispensation information for a subject visit."
}

Examples

Select an example Dispensation Info 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 Dispensation Info Bad Request Response

404 Response

Invalid study ID or visit ID 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 Dispensation Info Not Found Response

500 Response

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

Back to Top