Jump to

• Request
• Response

v5.0

get

/ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/shipments/{shipmentId}

Retrieves shipment containing source and destination locations by shipment ID. Rights: OrsInventoryGet, OrsUnblinded.

Request

Path Parameters

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

  Example:

  active

• shipmentId(required): string(uuid)
  ID of the shipment.

  Example:

  89EE76326E984B548D594D592E5C7FC2

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

  Example:

  D313327EF13845169A8ADADDA435431E

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ShipmentTO

Type: object

Show Source

• createdDate: string (date-time)
  Shipment creation date.
• destinationId: string (uuid)
  Destination ID.
• destinationName: string
  Destination name.

  Example: Site Houston
• destinationShortName: string
  Destination short name.

  Example: st_hstn
• isDepotShipment: boolean
  Depot shipment indicator.

  Example: true
• kitCountsByStatusId: object Kit Counts By Status ID
  Title: Kit Counts By Status ID

  Additional Properties Allowed: Kit Counts By Status ID

  Map of kit counts grouped by status ID.
• lastStatusUpdateDate: string (date-time)
  Title: Last Status Update Date

  Last status update date of the shipment.
• orderType: string
  Order type (Manual or Resupply).

  Example: Manual
• originId: string (uuid)
  Origin ID.
• originName: string
  Origin name.

  Example: Depot Houston
• originShortName: string
  Origin short name.

  Example: dpt_hstn
• quarantineKitCount: number (Integer)
  Number of kits in quarantine on the shipment.

  Example: 10
• reconciliation: boolean
  Indicates whether kit reconciliation is included.

  Example: true
• reportId: string (uuid)
  Report ID.
• shipDate: string (date-time)
  Ship date.
• shipmentId: string
  Shipment ID.

  Example: B1B8327AFAA6412287106192AB5984EF
• shipmentNumber: string
  Shipment number.

  Example: 123
• shipmentReceivedDate: string (date-time)
  Title: Shipment received date

  Shipment received date.
• shipmentRegisteredDate: string (date-time)
  Title: Shipment registered date

  Shipment registered date.
• statusId: number (Integer)
  Shipment status ID.

  Example: 5
• trackingNumber: string
  Shipment tracking number.

  Example: 12345
• trackingNumberURL: string
  Tracking URL.

  Example: http://www.site.com

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "destinationId":{
            "type":"string",
            "description":"Destination ID.",
            "format":"uuid"
        },
        "destinationName":{
            "type":"string",
            "description":"Destination name.",
            "example":"Site Houston"
        },
        "destinationShortName":{
            "type":"string",
            "description":"Destination short name.",
            "example":"st_hstn"
        },
        "originId":{
            "type":"string",
            "description":"Origin ID.",
            "format":"uuid"
        },
        "originName":{
            "type":"string",
            "description":"Origin name.",
            "example":"Depot Houston"
        },
        "originShortName":{
            "type":"string",
            "description":"Origin short name.",
            "example":"dpt_hstn"
        },
        "statusId":{
            "type":"number",
            "description":"Shipment status ID.",
            "format":"Integer",
            "example":5
        },
        "shipmentNumber":{
            "type":"string",
            "description":"Shipment number.",
            "example":"123"
        },
        "createdDate":{
            "type":"string",
            "description":"Shipment creation date.",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "description":"Ship date.",
            "format":"date-time"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "reportId":{
            "type":"string",
            "description":"Report ID.",
            "format":"uuid"
        },
        "isDepotShipment":{
            "type":"boolean",
            "description":"Depot shipment indicator.",
            "example":true
        },
        "quarantineKitCount":{
            "type":"number",
            "description":"Number of kits in quarantine on the shipment.",
            "format":"Integer",
            "example":10
        },
        "orderType":{
            "type":"string",
            "description":"Order type (Manual or Resupply).",
            "example":"Manual"
        },
        "lastStatusUpdateDate":{
            "title":"Last Status Update Date",
            "type":"string",
            "description":"Last status update date of the shipment.",
            "format":"date-time"
        },
        "kitCountsByStatusId":{
            "title":"Kit Counts By Status ID",
            "type":"object",
            "additionalProperties":{
                "title":"Kit Counts By Status ID",
                "type":"integer",
                "description":"Map of kit counts grouped by status ID.",
                "format":"int64"
            },
            "description":"Map of kit counts grouped by status ID."
        },
        "shipmentReceivedDate":{
            "title":"Shipment received date",
            "type":"string",
            "description":"Shipment received date.",
            "format":"date-time"
        },
        "shipmentRegisteredDate":{
            "title":"Shipment registered date ",
            "type":"string",
            "description":"Shipment registered date.",
            "format":"date-time"
        },
        "reconciliation":{
            "type":"boolean",
            "description":"Indicates whether kit reconciliation is included.",
            "example":true
        },
        "trackingNumberURL":{
            "type":"string",
            "description":"Tracking URL.",
            "example":"http://www.site.com"
        }
    }
}

Nested Schema : Kit Counts By Status ID

Type: object

Title: Kit Counts By Status ID

Additional Properties Allowed

Show Source

• integer(int64)
  Title: Kit Counts By Status ID

  Map of kit counts grouped by status ID.

{
    "title":"Kit Counts By Status ID",
    "type":"object",
    "additionalProperties":{
        "title":"Kit Counts By Status ID",
        "type":"integer",
        "description":"Map of kit counts grouped by status ID.",
        "format":"int64"
    },
    "description":"Map of kit counts grouped by status ID."
}

Map of kit counts grouped by status ID.

Examples

Select an example Get Shipment Response

404 Response

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

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

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 : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Not Found

500 Response

Internal server error

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

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 : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Server Error

Back to Top