Jump to

• Request
• Response

Create shipment for kits marked for destruction in a study

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments

Retrieves a list of resupply orders where each order contains an order ID and an order status. In the request body, kitRange should have the following format: KIT_NUMBER:min:max. Rights: OrsInventoryPost and either SourceDataVerification or OrsUnblinded.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of the study

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ManualDepotSupplyRequest v1.0

Type: object

Title: ManualDepotSupplyRequest v1.0

Manual depot-to-depot supply request object.

Show Source

• jobInstanceId: string
  Job instance Id.

  Example: 4FEBE3E166454E2687C6FAC306E7C86E
• kits: array kits
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647
• shippedFrom(required): string (uuid)
  Source depot ID
• shippedTo(required): string (uuid)
  Destination depot ID

{
    "title":"ManualDepotSupplyRequest v1.0",
    "required":[
        "shippedFrom",
        "shippedTo"
    ],
    "type":"object",
    "properties":{
        "jobInstanceId":{
            "type":"string",
            "description":"Job instance Id.",
            "example":"4FEBE3E166454E2687C6FAC306E7C86E"
        },
        "kits":{
            "maxItems":"2147483647",
            "minItems":"1",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepotShipmentKitRequest"
            }
        },
        "shippedFrom":{
            "type":"string",
            "description":"Source depot ID",
            "format":"uuid"
        },
        "shippedTo":{
            "type":"string",
            "description":"Destination depot ID",
            "format":"uuid"
        }
    },
    "description":"Manual depot-to-depot supply request object."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: object DepotShipmentKitRequest
  Contains kit details for depot shipment creation.

{
    "maxItems":"2147483647",
    "minItems":"1",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepotShipmentKitRequest"
    }
}

Nested Schema : DepotShipmentKitRequest

Type: object

Contains kit details for depot shipment creation.

Show Source

• kitTypeId: string (uuid)
  ID of the kit type.
• quantity: string
  Kit quantity

  Example: 2

{
    "type":"object",
    "properties":{
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "quantity":{
            "type":"string",
            "description":"Kit quantity",
            "example":"2"
        }
    },
    "description":"Contains kit details for depot shipment creation."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ResupplyResponse
  Response object containing resupply details.

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

Nested Schema : ResupplyResponse

Type: object

Response object containing resupply details.

Show Source

• orderId: string (uuid)
  Order Id
• status: string
  Allowed Values: [ "PENDING", "INTRANSIT", "RECEIVED", "CANCELLED", "LOST", "CONFIRMED", "INVALID", "PENDING_DESTRUCTION", "RECEIVED_FOR_DESTRUCTION", "DESTROYED" ]

  Order status.

  Example: DESTROYED

{
    "type":"object",
    "properties":{
        "orderId":{
            "type":"string",
            "description":"Order Id",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "description":"Order status.",
            "example":"DESTROYED",
            "enum":[
                "PENDING",
                "INTRANSIT",
                "RECEIVED",
                "CANCELLED",
                "LOST",
                "CONFIRMED",
                "INVALID",
                "PENDING_DESTRUCTION",
                "RECEIVED_FOR_DESTRUCTION",
                "DESTROYED"
            ]
        }
    },
    "description":"Response object containing resupply details."
}

400 Response

'Kit reconciliation required was not set.','You can't update the status of this kit because the kit was sent to a depot.','You can't update the status of this kit because it's at a site that you don't have access to. Work with your clinical research associate or a clinical supply manager to update the kit.','Reconciliation shipment is not allowed as site has drug destruction capability.','Reconciliation shipment cannot be created as none of the depots have drug destruction capability.','Update kits cannot have both the kit identifiers list and the kits filter set.','Update kits must have either the kit identifiers list or the kits filter set.','Invalid inventory status transition.','Invalid kit at site.', 'Invalid kit range filter.', 'Subject ID is required.','Invalid subject.', 'Update kits no rows were found to update.','Update kits retrieved size of exceeds maximum rows for update limit of.','Update kits retrieve error, the following kit identifiers were not found.'

Body ()

Root 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 : details

Type: object

404 Response

Site ID not found in site service.

Body ()

Root 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 : details

Type: object

500 Response

Internal server error

Body ()

Root 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 : details

Type: object

Back to Top