Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots

Deprecated: Retrieves all manufacturing lots by study ID. Rights: LotManagementGet.

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

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

Type: array

Show Source

• Array of: object Manufacturing Lot v1.0
  Title: Manufacturing Lot v1.0

  Manufacturing lot details.

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

Nested Schema : Manufacturing Lot v1.0

Type: object

Title: Manufacturing Lot v1.0

Manufacturing lot details.

Show Source

• blindedLotId: string (uuid)
  Title: Blinded Lot ID

  Blinded lot ID.
• doNotCount: number (BigDecimal)
  Title: Do Not Count

  Do Not Count (DNC) days.

  Example: 10
• doNotShip: number (BigDecimal)
  Title: Do Not Ship

  Do Not Ship (DNS) days.

  Example: 10
• expirationDate: string (date-time)
  Title: Expiration Date

  Expiration date.
• lotId: string (uuid)
  Title: Lot ID

  Lot ID.
• lotNumber: string
  Title: Lot Number

  Lot number.

  Example: Lot1001
• manufacturingLotNumber: string
  Title: Manufacturing Lot Number

  Manufacturing lot number.

  Example: Mlot1001

{
    "title":"Manufacturing Lot v1.0",
    "type":"object",
    "properties":{
        "manufacturingLotNumber":{
            "title":"Manufacturing Lot Number",
            "type":"string",
            "description":"Manufacturing lot number.",
            "example":"Mlot1001"
        },
        "expirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time"
        },
        "blindedLotId":{
            "title":"Blinded Lot ID",
            "type":"string",
            "description":"Blinded lot ID.",
            "format":"uuid"
        },
        "doNotCount":{
            "title":"Do Not Count",
            "type":"number",
            "description":"Do Not Count (DNC) days.",
            "format":"BigDecimal",
            "example":10
        },
        "doNotShip":{
            "title":"Do Not Ship",
            "type":"number",
            "description":"Do Not Ship (DNS) days.",
            "format":"BigDecimal",
            "example":10
        },
        "lotNumber":{
            "title":"Lot Number",
            "type":"string",
            "description":"Lot number.",
            "example":"Lot1001"
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        }
    },
    "description":"Manufacturing lot details."
}

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