Jump to

• Request
• Response

[Deprecated]: v1.0

post

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

Deprecated: Creates a blinded lot by study ID. Rights: LotManagementPost.

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 : BlindedLotRequestV2.0

Type: object

Title: BlindedLotRequestV2.0

Request object to create blinded lot with country-specific settings.

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.
• settingsByCountry: array settingsByCountry
• shortName: string
  Minimum Length: 0

  Maximum Length: 50

  Blinded lot short name.

  Example: BlindedLot-01

{
    "title":"BlindedLotRequestV2.0",
    "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"
            }
        }
    },
    "description":"Request object to create blinded lot with country-specific settings."
}

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

Type: object

Contains blinded lot id.

Show Source

• id: string (uuid)
  Unique Id for blinded lot.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique Id for blinded lot.",
            "format":"uuid"
        }
    },
    "description":"Contains blinded lot id."
}

Examples

Select an example Create Blinded Lot Response

400 Response

Blinded lot number or lot short name already exists. OR Expiration date is not valid. OR Invalid lot. OR Lot belongs to a blinded lot.

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 Create Blinded Lot Bad Request Response

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
  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 Create Blinded Lot Forbidden 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 Create Blinded Lot Server Error Response

Back to Top