Jump to

• Request
• Response

v1.0

post

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

Cancels a reconciliation shipment.
Rights: OrsInventoryPost and OrsBlinded or OrsUnblinded.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

Supported Media Types

• */*

Request Body - */* ()

Root Schema : Cancel Reconciliation Shipment Request

Type: object

Title: Cancel Reconciliation Shipment Request

Cancel recon shipment parameters.

Show Source

• shipmentIds(required): array shipmentIds
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Unique Items Required: true

  Contains shipment IDs.

{
    "title":"Cancel Reconciliation Shipment Request",
    "required":[
        "shipmentIds"
    ],
    "type":"object",
    "properties":{
        "shipmentIds":{
            "maxItems":2147483647,
            "minItems":1,
            "uniqueItems":true,
            "type":"array",
            "description":"Contains shipment IDs.",
            "example":[
                "E39FF55A445543A38D513325664F0B2D",
                "8ECE2C9D389645B09740DC7926DEFB69"
            ],
            "items":{
                "type":"string",
                "description":"Contains shipment IDs.",
                "format":"uuid"
            }
        }
    },
    "description":"Cancel recon shipment parameters."
}

Nested Schema : shipmentIds

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

Contains shipment IDs.

Show Source

• Array of: string(uuid)
  Contains shipment IDs.

{
    "maxItems":2147483647,
    "minItems":1,
    "uniqueItems":true,
    "type":"array",
    "description":"Contains shipment IDs.",
    "example":[
        "E39FF55A445543A38D513325664F0B2D",
        "8ECE2C9D389645B09740DC7926DEFB69"
    ],
    "items":{
        "type":"string",
        "description":"Contains shipment IDs.",
        "format":"uuid"
    }
}

Example:

[
    "E39FF55A445543A38D513325664F0B2D",
    "8ECE2C9D389645B09740DC7926DEFB69"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

400 Response

'Invalid kit status.', 'Invalid shipment.', 'One or more shipments are not in a valid status.'

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Cancel Recon Shipment Bad Request Response

403 Response

User doesn't have access to the site

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Cancel Recon Shipment Forbidden Response

500 Response

Internal server error

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Cancel Recon Shipment Server Error Response

Back to Top