Jump to

• Request
• Response

v3.0

post

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

Creates blinded lot with release depot to depot settings.

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:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Blinded Lot Request

Type: object

Title: Blinded Lot Request

Blinded lot request parameters.

Show Source

• blindedLotNumber(required): string
  Minimum Length: 0

  Maximum Length: 50

  Blinded lot number.

  Example: Bld-Lt-AZ
• doNotCount: number (BigDecimal)
  Minimum Value: 0

  Maximum Value: 99999

  Do not count (DNC) days.

  Example: 10
• doNotShip: number (BigDecimal)
  Minimum Value: 0

  Maximum Value: 99999

  Do not ship (DNS) days.

  Example: 50
• expirationDate(required): string (date)
  Expiration date of the blinded lot.

  Example: 2022-04-01
• manufacturingLotIds: array manufacturingLotIds
  IDs of manufacturing lots associated with the blinded lot.
• releaseForDepotToDepot: boolean
  Indicates whether release depot-to-depot is enabled.

  Example: true
• settingsByCountry: array settingsByCountry
• shortName: string
  Minimum Length: 0

  Maximum Length: 50

  Blinded lot short name.

  Example: BlindedLot-01

{
    "title":"Blinded Lot Request",
    "required":[
        "blindedLotNumber",
        "expirationDate"
    ],
    "type":"object",
    "properties":{
        "blindedLotNumber":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Blinded lot number.",
            "example":"Bld-Lt-AZ"
        },
        "shortName":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Blinded lot short name.",
            "example":"BlindedLot-01"
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date of the blinded lot.",
            "format":"date",
            "example":"2022-04-01"
        },
        "doNotShip":{
            "maximum":99999,
            "minimum":0,
            "type":"number",
            "description":"Do not ship (DNS) days.",
            "format":"BigDecimal",
            "example":50
        },
        "doNotCount":{
            "maximum":99999,
            "minimum":0,
            "type":"number",
            "description":"Do not count (DNC) days.",
            "format":"BigDecimal",
            "example":10
        },
        "manufacturingLotIds":{
            "type":"array",
            "description":"IDs of manufacturing lots associated with the blinded lot.",
            "example":[
                "392DA9F053E94B9B9339AC7D0FA0D1DB"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "settingsByCountry":{
            "type":"array",
            "example":[
                {
                    "countryIso":"US",
                    "doNotShip":50,
                    "doNotCount":10
                }
            ],
            "items":{
                "$ref":"#/components/schemas/CountrySupplySettings"
            }
        },
        "releaseForDepotToDepot":{
            "type":"boolean",
            "description":"Indicates whether release depot-to-depot is enabled.",
            "example":true
        }
    },
    "description":"Blinded lot request parameters."
}

Nested Schema : manufacturingLotIds

Type: array

IDs of manufacturing lots associated with the blinded lot.

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "description":"IDs of manufacturing lots associated with the blinded lot.",
    "example":[
        "392DA9F053E94B9B9339AC7D0FA0D1DB"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "392DA9F053E94B9B9339AC7D0FA0D1DB"
]

Nested Schema : settingsByCountry

Type: array

Show Source

• Array of: object CountrySupplySettings

{
    "type":"array",
    "example":[
        {
            "countryIso":"US",
            "doNotShip":50,
            "doNotCount":10
        }
    ],
    "items":{
        "$ref":"#/components/schemas/CountrySupplySettings"
    }
}

Example:

[
    {
        "countryIso":"US",
        "doNotShip":50,
        "doNotCount":10
    }
]

Nested Schema : CountrySupplySettings

Type: object

Show Source

• countryIso(required): string
  ISO 3166-1 alpha-2 country code.

  Example: US
• doNotCount(required): number (BigDecimal)
  Minimum Value: 0

  Maximum Value: 99999

  Do not count (DNC) days.

  Example: 10
• doNotShip(required): number (BigDecimal)
  Minimum Value: 0

  Maximum Value: 99999

  Do not ship (DNS) days.

  Example: 50

{
    "required":[
        "countryIso",
        "doNotCount",
        "doNotShip"
    ],
    "type":"object",
    "properties":{
        "countryIso":{
            "type":"string",
            "description":"ISO 3166-1 alpha-2 country code.",
            "example":"US"
        },
        "doNotShip":{
            "maximum":99999,
            "minimum":0,
            "type":"number",
            "description":"Do not ship (DNS) days.",
            "format":"BigDecimal",
            "example":50
        },
        "doNotCount":{
            "maximum":99999,
            "minimum":0,
            "type":"number",
            "description":"Do not count (DNC) days.",
            "format":"BigDecimal",
            "example":10
        }
    },
    "example":{
        "countryIso":"US",
        "doNotShip":50,
        "doNotCount":10
    }
}

Example:

{
    "countryIso":"US",
    "doNotShip":50,
    "doNotCount":10
}

Examples

Select an example Create Blinded Lot Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : IDResponse v1.0

Type: object

Title: IDResponse v1.0

Response containing the identifier.

Show Source

• id: string (uuid)
  ID

{
    "title":"IDResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        }
    },
    "description":"Response containing the identifier."
}

Examples

Select an example Create Blinded Lot Response

400 Response

v3.0 The study identifier does not match any study identifiers in Clinical One

Body ()

Root Schema : IDResponse v1.0

Type: object

Title: IDResponse v1.0

Response containing the identifier.

Show Source

• id: string (uuid)
  ID

{
    "title":"IDResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        }
    },
    "description":"Response containing the identifier."
}

Examples

Select an example Create Blinded Lot Bad Request Response

404 Response

Blinded lot not found

Body ()

Root Schema : IDResponse v1.0

Type: object

Title: IDResponse v1.0

Response containing the identifier.

Show Source

• id: string (uuid)
  ID

{
    "title":"IDResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        }
    },
    "description":"Response containing the identifier."
}

Examples

Select an example Create Blinded Lot Not Found Response

Back to Top