Jump to

• Request
• Response

v2.0

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/blinded-lots

Retrieves list of blinded lots by study ID. Rights: LotManagementGet, ORSBlindedDepotGet.

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.

Query Parameters

• includeDeleted: boolean
• limit: integer(int32)
  Maximum number of records to display per page.
• offset: integer(int32)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : BlindedLotsResponse v2.0

Type: object

Title: BlindedLotsResponse v2.0

Response containing blinded lots.

Show Source

• blindedLots: array Blinded Lots
  Title: Blinded Lots

  List of blinded lots.

{
    "title":"BlindedLotsResponse v2.0",
    "type":"object",
    "properties":{
        "blindedLots":{
            "title":"Blinded Lots",
            "type":"array",
            "description":"List of blinded lots.",
            "items":{
                "$ref":"#/components/schemas/BlindedLotsV2"
            }
        }
    },
    "description":"Response containing blinded lots."
}

Nested Schema : Blinded Lots

Type: array

Title: Blinded Lots

List of blinded lots.

Show Source

• Array of: object BlindedLots v2.0
  Title: BlindedLots v2.0

  Contains blinded lot details.

{
    "title":"Blinded Lots",
    "type":"array",
    "description":"List of blinded lots.",
    "items":{
        "$ref":"#/components/schemas/BlindedLotsV2"
    }
}

Nested Schema : BlindedLots v2.0

Type: object

Title: BlindedLots v2.0

Contains blinded lot details.

Show Source

• blindedLotNumber: string
  Title: Blinded Lot Number

  Blinded lot number.

  Example: Blot1001
• comment: string
  Comment.
• doNotCount: number
  Title: Do Not Count

  Do Not Count (DNC) days.
• doNotShip: number
  Title: Do Not Ship

  Do Not Ship (DNS) days.
• expirationDate: string (date-time)
  Title: Expiration Date

  Blinded lot expiration date.
• id: string (uuid)
  Title: Blinded Lot ID

  Blinded lot ID.
• inUse: boolean
  Indicates whether the lot is in use.
• manufacturingLotIds: array Manufacturing Lot IDs
  Title: Manufacturing Lot IDs

  List of manufacturing lot IDs.
• objectVersionNumber: number (double)
  Object version number.
• operationType: string
  Operation type.
• reason: string
  Reason.
• settingsByCountry: array settingsByCountry
  List of settings by country.
• shortName: string
  Title: Short Name

  Blinded lot short name.

  Example: Blot1001
• softwareVersionNumber: number (double)
  Software version number.
• userId: string (uuid)
  User ID.
• versionEnd: string (date-time)
  Blinded lot version end date.
• versionStart: string (date-time)
  Blinded lot version start date.

{
    "title":"BlindedLots v2.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"Blinded Lot ID",
            "type":"string",
            "description":"Blinded lot ID.",
            "format":"uuid"
        },
        "blindedLotNumber":{
            "title":"Blinded Lot Number",
            "type":"string",
            "description":"Blinded lot number.",
            "example":"Blot1001"
        },
        "shortName":{
            "title":"Short Name",
            "type":"string",
            "description":"Blinded lot short name.",
            "example":"Blot1001"
        },
        "expirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Blinded lot expiration date.",
            "format":"date-time"
        },
        "doNotShip":{
            "title":"Do Not Ship",
            "type":"number",
            "description":"Do Not Ship (DNS) days."
        },
        "doNotCount":{
            "title":"Do Not Count",
            "type":"number",
            "description":"Do Not Count (DNC) days."
        },
        "manufacturingLotIds":{
            "title":"Manufacturing Lot IDs",
            "type":"array",
            "description":"List of manufacturing lot IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "versionStart":{
            "type":"string",
            "description":"Blinded lot version start date.",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "description":"Blinded lot version end date.",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type."
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "format":"double"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number.",
            "format":"double"
        },
        "reason":{
            "type":"string",
            "description":"Reason."
        },
        "comment":{
            "type":"string",
            "description":"Comment."
        },
        "inUse":{
            "type":"boolean",
            "description":"Indicates whether the lot is in use."
        },
        "settingsByCountry":{
            "type":"array",
            "description":"List of settings by country.",
            "items":{
                "$ref":"#/components/schemas/SettingsByCountryV2"
            }
        }
    },
    "description":"Contains blinded lot details."
}

Nested Schema : Manufacturing Lot IDs

Type: array

Title: Manufacturing Lot IDs

List of manufacturing lot IDs.

Show Source

• Array of: string(uuid)

{
    "title":"Manufacturing Lot IDs",
    "type":"array",
    "description":"List of manufacturing lot IDs.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : settingsByCountry

Type: array

List of settings by country.

Show Source

• Array of: object SettingsByCountry v2.0
  Title: SettingsByCountry v2.0

  Contains settings by country.

{
    "type":"array",
    "description":"List of settings by country.",
    "items":{
        "$ref":"#/components/schemas/SettingsByCountryV2"
    }
}

Nested Schema : SettingsByCountry v2.0

Type: object

Title: SettingsByCountry v2.0

Contains settings by country.

Show Source

• countryIso: string
  Country ISO code.
• doNotCount: number (double)
  Do Not Count (DNC) Days.
• doNotShip: number (double)
  Do Not Ship (DNS) Days.
• id: string (uuid)
  ID
• userId: string (uuid)
  User ID.
• versionStart: string (date-time)
  Version start date.

{
    "title":"SettingsByCountry v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        },
        "countryIso":{
            "type":"string",
            "description":"Country ISO code."
        },
        "doNotCount":{
            "type":"number",
            "description":"Do Not Count (DNC) Days.",
            "format":"double"
        },
        "doNotShip":{
            "type":"number",
            "description":"Do Not Ship (DNS) Days.",
            "format":"double"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start date.",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        }
    },
    "description":"Contains settings by country."
}

403 Response

The study identifier does not match any study identifiers in Clinical One

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