Jump to

• Request
• Response

v2.0

post

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments

Rights needed: DDFShipmentPost; versioned to return the form ID in the response.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• siteId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request object to create a reconciliation shipment.

Show Source

• kits: array kits
  Minimum Number of Items: 1

  Contains kit IDs.
• kitsFilter: object ReconShipmentKitsFilter
  Contains filters for kits for a reconciliation shipment.
• unblinded: boolean
  Indicates whether unblinded or blinded.

  Example: true

{
    "type":"object",
    "properties":{
        "kits":{
            "minItems":1,
            "type":"array",
            "description":"Contains kit IDs.",
            "items":{
                "type":"string",
                "format":"uuid",
                "example":"e39ff55a-4455-43a3-8d51-3325664f0b2d"
            }
        },
        "kitsFilter":{
            "$ref":"#/components/schemas/ReconShipmentKitsFilter"
        },
        "unblinded":{
            "type":"boolean",
            "description":"Indicates whether unblinded or blinded.",
            "example":true
        }
    },
    "description":"Request object to create a reconciliation shipment."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Contains kit IDs.

Show Source

• Array of: string(uuid)
  Example: e39ff55a-4455-43a3-8d51-3325664f0b2d

{
    "minItems":1,
    "type":"array",
    "description":"Contains kit IDs.",
    "items":{
        "type":"string",
        "format":"uuid",
        "example":"e39ff55a-4455-43a3-8d51-3325664f0b2d"
    }
}

Nested Schema : ReconShipmentKitsFilter

Type: object

Contains filters for kits for a reconciliation shipment.

Show Source

• inventoryStatusIds: array inventoryStatusIds
  Contains inventory status IDs.
• kitRange: string (KIT_NUMBER:XXX:XXX)
  Range of kit numbers.

  Example: KIT_NUMBER:10:100
• searchString: string
  Search string for kits.

  Example: Some search string
• subjectId: string (uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

{
    "type":"object",
    "properties":{
        "kitRange":{
            "type":"string",
            "description":"Range of kit numbers.",
            "format":"KIT_NUMBER:XXX:XXX",
            "example":"KIT_NUMBER:10:100"
        },
        "searchString":{
            "type":"string",
            "description":"Search string for kits.",
            "example":"Some search string"
        },
        "inventoryStatusIds":{
            "type":"array",
            "description":"Contains inventory status IDs.",
            "items":{
                "type":"integer",
                "format":"int32",
                "example":5
            }
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"uuid"
        }
    },
    "description":"Contains filters for kits for a reconciliation shipment."
}

Nested Schema : inventoryStatusIds

Type: array

Contains inventory status IDs.

Show Source

• Array of: integer(int32)
  Example: 5

{
    "type":"array",
    "description":"Contains inventory status IDs.",
    "items":{
        "type":"integer",
        "format":"int32",
        "example":5
    }
}

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
  Title: ResupplyResponse

  Response object containing resupply details.

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

Nested Schema : ResupplyResponse

Type: object

Title: ResupplyResponse

Response object containing resupply details.

Show Source

• formId: string (uuid)
  Title: Form ID

  Identifier of the form associated with the resupply.
• 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

{
    "title":"ResupplyResponse",
    "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"
            ]
        },
        "formId":{
            "title":"Form ID",
            "type":"string",
            "description":"Identifier of the form associated with the resupply.",
            "format":"uuid"
        }
    },
    "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 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