Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation

Retrieves dispensation details like subject source ID, visit source ID and instance number for a given inventory ID. Rights: OrsInventoryGet.

Request

Path Parameters

• inventoryId(required): string(uuid)
  ID of the inventory

  Example:

  b1b8327a-faa6-4122-8710-6192ab5984ef

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

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : InventoryDispensationResponse v1.0

Type: object

Title: InventoryDispensationResponse v1.0

Contains dispensation details.

Show Source

• instanceNumber: number
  Title: Instance Number

  Visit instance number.

  Example: 1
• kitNumber: number
  Title: Kit Number

  Kit number.

  Example: 1001
• subjectSrcId: string (uuid)
  Title: Subject Source ID

  Subject source identifier.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• visitSrcId: string (uuid)
  Title: Visit Source ID

  Visit source identifier.

  Example: 7f2c9f12-3456-7890-abcd-1234567890ab

{
    "title":"InventoryDispensationResponse v1.0",
    "type":"object",
    "properties":{
        "subjectSrcId":{
            "title":"Subject Source ID",
            "type":"string",
            "description":"Subject source identifier.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "visitSrcId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Visit source identifier.",
            "format":"uuid",
            "example":"7f2c9f12-3456-7890-abcd-1234567890ab"
        },
        "instanceNumber":{
            "title":"Instance Number",
            "type":"number",
            "description":"Visit instance number.",
            "example":1
        },
        "kitNumber":{
            "title":"Kit Number",
            "type":"number",
            "description":"Kit number.",
            "example":1001
        }
    },
    "description":"Contains dispensation details."
}

Examples

Select an example Get Inventory Dispensation Response

404 Response

Invalid study ID or version

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Get Inventory Dispensation Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Get Inventory Dispensation Server Error Response

Back to Top