Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lotsbykittype/sdfs/{sdfType}/{sdfId}

Retrieves Kit Type by lot for the site. Rights: LotManagementGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• sdfId(required): string
  Site ID.

  Example:

  A0B1C2D3E4F5064789A0B1C2D3E4F506

• sdfType(required): string
  Type of SDF: sites or depots.

  Example:

  site

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Query Parameters

• srcDepotId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical depot

  Example:

  8C7A6B5D4E3F2109876543210ABCDEF0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Kit Lot Details

Type: object

Title: Kit Lot Details

Contains kit types with lots information.

Show Source

• kitTypes: array kitTypes

{
    "title":"Kit Lot Details",
    "type":"object",
    "properties":{
        "kitTypes":{
            "type":"array",
            "example":[
                {
                    "kitTypeSrcId":"B1B8327AFAA6412287106192AB5984EF",
                    "lots":[
                        {
                            "quantity":10,
                            "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
                            "effectiveExpirationDate":"2027-12-31T00:00:00Z",
                            "lotName":"LOT-1001"
                        }
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/KitTypeLotsTO"
            }
        }
    },
    "description":"Contains kit types with lots information."
}

Nested Schema : kitTypes

Type: array

Show Source

• Array of: object Kit Type Lots
  Title: Kit Type Lots

  Kit type with lots.

{
    "type":"array",
    "example":[
        {
            "kitTypeSrcId":"B1B8327AFAA6412287106192AB5984EF",
            "lots":[
                {
                    "quantity":10,
                    "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
                    "effectiveExpirationDate":"2027-12-31T00:00:00Z",
                    "lotName":"LOT-1001"
                }
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/KitTypeLotsTO"
    }
}

Example:

[
    {
        "kitTypeSrcId":"B1B8327AFAA6412287106192AB5984EF",
        "lots":[
            {
                "quantity":10,
                "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
                "effectiveExpirationDate":"2027-12-31T00:00:00Z",
                "lotName":"LOT-1001"
            }
        ]
    }
]

Nested Schema : Kit Type Lots

Type: object

Title: Kit Type Lots

Kit type with lots.

Show Source

• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• lots: array lots

{
    "title":"Kit Type Lots",
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "lots":{
            "type":"array",
            "example":[
                {
                    "quantity":10,
                    "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
                    "effectiveExpirationDate":"2027-12-31T00:00:00Z",
                    "lotName":"LOT-1001"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/LotsTO"
            }
        }
    },
    "description":"Kit type with lots.",
    "example":[
        {
            "kitTypeSrcId":"B1B8327AFAA6412287106192AB5984EF",
            "lots":[
                {
                    "quantity":10,
                    "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
                    "effectiveExpirationDate":"2027-12-31T00:00:00Z",
                    "lotName":"LOT-1001"
                }
            ]
        }
    ]
}

Example:

[
    {
        "kitTypeSrcId":"B1B8327AFAA6412287106192AB5984EF",
        "lots":[
            {
                "quantity":10,
                "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
                "effectiveExpirationDate":"2027-12-31T00:00:00Z",
                "lotName":"LOT-1001"
            }
        ]
    }
]

Nested Schema : lots

Type: array

Show Source

• Array of: object Lots
  Title: Lots

  Contains lot details for kits.

{
    "type":"array",
    "example":[
        {
            "quantity":10,
            "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
            "effectiveExpirationDate":"2027-12-31T00:00:00Z",
            "lotName":"LOT-1001"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/LotsTO"
    }
}

Example:

[
    {
        "quantity":10,
        "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
        "effectiveExpirationDate":"2027-12-31T00:00:00Z",
        "lotName":"LOT-1001"
    }
]

Nested Schema : Lots

Type: object

Title: Lots

Contains lot details for kits.

Show Source

• effectiveExpirationDate: string (date-time)
  Title: Effective Expiration Date

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

  Lot ID.
• lotName: string
  Title: Lot Name

  Lot name.

  Example: Lot01
• quantity: number (BigDecimal)
  Title: Quantity

  Kit quantity.

  Example: 10

{
    "title":"Lots",
    "type":"object",
    "properties":{
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal",
            "example":10
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "effectiveExpirationDate":{
            "title":"Effective Expiration Date",
            "type":"string",
            "description":"Effective expiration date.",
            "format":"date-time"
        },
        "lotName":{
            "title":"Lot Name",
            "type":"string",
            "description":"Lot name.",
            "example":"Lot01"
        }
    },
    "description":"Contains lot details for kits.",
    "example":[
        {
            "quantity":10,
            "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
            "effectiveExpirationDate":"2027-12-31T00:00:00Z",
            "lotName":"LOT-1001"
        }
    ]
}

Example:

[
    {
        "quantity":10,
        "lotId":"1873CDF69E9B48B89B2D9E7951057D09",
        "effectiveExpirationDate":"2027-12-31T00:00:00Z",
        "lotName":"LOT-1001"
    }
]

Examples

Select an example Kit types lots

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

Examples

Select an example Get Kit Types By Lots By Site Forbidden Response

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

Examples

Select an example Get Kit Types By Lots By Site Server Error Response

Back to Top