Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/eligible-kits

Retrieves all kits eligible to be received against a shipment. Rights: OrsSupplyManagerGet and OrsBlinded.

Request

Path Parameters

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

  Example:

  test

• shipmentId(required): string(uuid)
  ID of the shipment.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ShipmentRecvEligibleKitsResponse

Type: object

Title: ShipmentRecvEligibleKitsResponse

Response object containing eligible kits of a received shipment.

Show Source

• kits: array kits
• shipmentId: string (uuid)
  ID of the shipment.

{
    "title":"ShipmentRecvEligibleKitsResponse",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ShipmentEligibleKitTOV1"
            }
        }
    },
    "description":"Response object containing eligible kits of a received shipment."
}

Nested Schema : kits

Type: array

Show Source

• Array of: object ShipmentEligibleKitTO v1.0
  Title: ShipmentEligibleKitTO v1.0

  Contains kit details belonging to shipment.

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

Nested Schema : ShipmentEligibleKitTO v1.0

Type: object

Title: ShipmentEligibleKitTO v1.0

Contains kit details belonging to shipment.

Show Source

• expirationDate: string (date-time)
  Expiration date.

  Example: 2025-05-09T00:00:00Z
• id: string (uuid)
  Inventory ID.
• kitNumber: number (double)
  Kit/Lot number.

  Example: 5
• kitTypeName: string
  Kit type name.

  Example: Kit A
• sequenceNumber: number (double)
  Sequence number.

  Example: 5

{
    "title":"ShipmentEligibleKitTO v1.0",
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit/Lot number.",
            "format":"double",
            "example":5
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"double",
            "example":5
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time",
            "example":"2025-05-09T00:00:00Z"
        },
        "id":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        }
    },
    "description":"Contains kit details belonging to shipment.",
    "example":{
        "kitId":"B1B8327AFAA6412287106192AB5984EF",
        "kitNumber":"KIT-000123"
    }
}

Example:

{
    "kitId":"B1B8327AFAA6412287106192AB5984EF",
    "kitNumber":"KIT-000123"
}

Examples

Select an example Get Eligible Kits For Received Response

400 Response

Invalid shipment type

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 Bad Request Response

404 Response

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid shipment ID'

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 Not Found 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 Server Error Response

Back to Top