Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/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
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• siteId(required): string(uuid)
  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:

  B1B8327AFAA6412287106192AB5984EF

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.",
            "example":[
                "E39FF55A445543A38D513325664F0B2D"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "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)

{
    "minItems":1,
    "type":"array",
    "description":"Contains kit IDs.",
    "example":[
        "E39FF55A445543A38D513325664F0B2D"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "E39FF55A445543A38D513325664F0B2D"
]

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 identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

{
    "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.",
            "example":[
                5
            ],
            "items":{
                "type":"integer",
                "format":"int32",
                "example":5
            }
        },
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"uuid"
        }
    },
    "description":"Contains filters for kits for a reconciliation shipment.",
    "example":{
        "kitRange":"KIT_NUMBER:10:100",
        "searchString":"Some search string",
        "inventoryStatusIds":[
            5
        ],
        "subjectId":"B1B8327AFAA6412287106192AB5984EF"
    }
}

Example:

{
    "kitRange":"KIT_NUMBER:10:100",
    "searchString":"Some search string",
    "inventoryStatusIds":[
        5
    ],
    "subjectId":"B1B8327AFAA6412287106192AB5984EF"
}

Nested Schema : inventoryStatusIds

Type: array

Contains inventory status IDs.

Show Source

• Array of: integer(int32)
  Example: 5

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

Example:

[
    5
]

Examples

Select an example Create Recon Shipment Request

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/ResupplyResponse"
    }
}

Nested Schema : ResupplyResponse

Type: object

Title: ResupplyResponse

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

{
    "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"
            ]
        }
    },
    "description":"Response object containing resupply details."
}

Examples

Select an example Create Recon Shipment Response

400 Response

'Kit reconciliation required was not set.', 'You cannot update the status of this kit because the kit was sent to a depot', 'You cannot update the status of this kit because it is at a site that you do not have access to. Work with your CRA 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 has 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.', 'subjectId 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

Examples

Select an example Create Recon Shipment Bad Request Response

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

Examples

Select an example Create Recon Shipment Not Found Response

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

Examples

Select an example Create Recon Shipment Server Error Response

Back to Top