Jump to

• Request
• Response

v1.0

post

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

Marks shipments as Lost in the system. Rights: OrsSupplyManagerPost, 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:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request object containing lost shipment details.

Show Source

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

  Maximum Number of Items: 2147483647

  Contains shipment IDs.

{
    "required":[
        "shipmentIds"
    ],
    "type":"object",
    "properties":{
        "shipmentIds":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "description":"Contains shipment IDs.",
            "example":[
                "E39FF55A445543A38D513325664F0B2D",
                "8ECE2C9D389645B09740DC7926DEFB69"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Request object containing lost shipment details."
}

Nested Schema : shipmentIds

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Contains shipment IDs.

Show Source

• Array of: string(uuid)

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

Example:

[
    "E39FF55A445543A38D513325664F0B2D",
    "8ECE2C9D389645B09740DC7926DEFB69"
]

Examples

Select an example Mark Shipments Lost Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Examples

Select an example Mark Shipments Lost Response

400 Response

'Invalid order status' or 'Invalid shipment type'

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : details

Type: object

Examples

Select an example Bad Request

404 Response

Invalid study ID, 'Study still in design phase', 'Invalid shipment ID'

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : details

Type: object

Examples

Select an example Not Found

500 Response

Internal server error

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : details

Type: object

Examples

Select an example Server Error

Back to Top