Jump to

• Request
• Response

v3.0

get

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}

Retrieves a shipment's details by ID for a site. This version includes additional attributes: versionStart and userId.
Rights: OrsSupplyManagerGet and OrsBlinded.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  89EE76326E984B548D594D592E5C7FC2

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

  Example:

  9B83BFB48C5A41C59775E4D8D22D8B26

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

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SiteUserShipmentTO v3.0

Type: object

Title: SiteUserShipmentTO v3.0

Response object containing details about shipment at a site.

Show Source

• availableCount: integer (int64)
  Available kits count.

  Example: 5
• createdDate: string (date-time)
  Shipment creation date.
• damagedCount: integer (int64)
  Damaged kits count.

  Example: 5
• depotId: string (uuid)
  Depot ID.
• depotName: string
  Depot name.

  Example: Depot Houston
• depotShortName: string
  Depot short name.

  Example: 123
• inTransitCount: integer (int64)
  In transit kits count.

  Example: 5
• missingCount: integer (int64)
  Missing kits count.

  Example: 5
• preQuarantinedCount: integer (int64)
  Pre quarantined kits count.

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

  Example: true
• reportId: string
  Report ID.

  Example: B1B8327AFAA6412287106192AB5984EF
• shipDate: string (date-time)
  Ship date.
• shipmentId: string
  ID of the shipment.

  Example: 123
• shipmentNumber: string
  Shipment number.

  Example: 123
• siteId: string (uuid)
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
• siteName: string
  Site name.

  Example: Site Houston
• siteShortName: string
  Site short name.

  Example: 12
• statusDate: string (date-time)
  Status 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
• userId: string (uuid)
  User ID.
• versionStart: string (date-time)
  Site version start date.

{
    "title":"SiteUserShipmentTO v3.0",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"123"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"uuid"
        },
        "siteName":{
            "type":"string",
            "description":"Site name.",
            "example":"Site Houston"
        },
        "siteShortName":{
            "type":"string",
            "description":"Site short name.",
            "example":"12"
        },
        "depotId":{
            "type":"string",
            "description":"Depot ID.",
            "format":"uuid"
        },
        "depotName":{
            "type":"string",
            "description":"Depot name.",
            "example":"Depot Houston"
        },
        "depotShortName":{
            "type":"string",
            "description":"Depot short name.",
            "example":"123"
        },
        "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"
        },
        "statusDate":{
            "type":"string",
            "description":"Status date.",
            "format":"date-time"
        },
        "damagedCount":{
            "type":"integer",
            "description":"Damaged kits count.",
            "format":"int64",
            "example":5
        },
        "missingCount":{
            "type":"integer",
            "description":"Missing kits count.",
            "format":"int64",
            "example":5
        },
        "preQuarantinedCount":{
            "type":"integer",
            "description":"Pre quarantined kits count.",
            "format":"int64",
            "example":5
        },
        "availableCount":{
            "type":"integer",
            "description":"Available kits count.",
            "format":"int64",
            "example":5
        },
        "inTransitCount":{
            "type":"integer",
            "description":"In transit kits count.",
            "format":"int64",
            "example":5
        },
        "reportId":{
            "type":"string",
            "description":"Report ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "versionStart":{
            "type":"string",
            "description":"Site version start date.",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "reconciliation":{
            "type":"boolean",
            "description":"Indicates whether kit reconciliation is included.",
            "example":true
        },
        "trackingNumberURL":{
            "type":"string",
            "description":"Tracking URL.",
            "example":"http://www.site.com"
        }
    },
    "description":"Response object containing details about shipment at a site."
}

Examples

Select an example Get Site Shipment Response

404 Response

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid site ID', '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 Get Site Shipment Not Found Response

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 Get Site Shipment Server Error Response

Back to Top