Jump to

• Request
• Response

Search shipments for a study

get

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

Searches for shipments associated with a study by study ID. Rights: OrsInventoryGet, OrsUnblinded, BlindedDepot.

Request

Path Parameters

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

Query Parameters

• depotShipment(required): boolean
  Boolean value for looking for depot shipments
• destinationId(required): string(uuid)
  String value for destination of shipment
• originId(required): string(uuid)
  String value for origin of shipment
• recon(required): boolean
  Boolean value for recon
• searchString(required): string
  Search string
• statusId(required): number
  ID of the status
• transactionId: string(uuid)
  String value for transaction ID of shipment

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ViewShipmentResponse

Type: object

Show Source

• count: integer (int64)
  Total count of result
• hasMore: boolean
  Attribute describes if result set has more records

  Example: true
• limit: integer (int64)
  Maximum number of records to display per page.
• links: array links
• offset: integer (int64)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

  Example: 400
• shipments: array shipments
• totalResults: integer (int64)
  Total number of entities in response

{
    "type":"object",
    "properties":{
        "shipments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ShipmentTO"
            }
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Attribute describes if result set has more records",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.",
            "format":"int64",
            "example":400
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object RelLink
  Object contains link detail.

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

Nested Schema : shipments

Type: array

Show Source

• Array of: object ShipmentTO

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

Nested Schema : RelLink

Type: object

Object contains link detail.

Show Source

• href: string
  Realtive URL
• rel: string
  link

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link"
        },
        "href":{
            "type":"string",
            "description":"Realtive URL"
        }
    },
    "description":"Object contains link detail."
}

Nested Schema : ShipmentTO

Type: object

Show Source

• createdDate: string (date-time)
• depotId: string (uuid)
• depotName: string
• depotShortName: string
• shipDate: string (date-time)
• shipmentId: string
• shipmentNumber: string
• siteId: string (uuid)
• siteName: string
• siteShortName: string
• statusId: integer (int32)
• trackingNumber: string
• trackingNumberURL: string

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string"
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "siteName":{
            "type":"string"
        },
        "siteShortName":{
            "type":"string"
        },
        "depotId":{
            "type":"string",
            "format":"uuid"
        },
        "depotName":{
            "type":"string"
        },
        "depotShortName":{
            "type":"string"
        },
        "statusId":{
            "type":"integer",
            "format":"int32"
        },
        "shipmentNumber":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "format":"date-time"
        },
        "trackingNumber":{
            "type":"string"
        },
        "trackingNumberURL":{
            "type":"string"
        }
    }
}

404 Response

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

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

500 Response

Internal server error

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top