Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: SI: Removed the 'Patch' shipment API page link. (As the 'Patch' page was removed)

Summary 

This page contains documentation of create shipment REST API.

 

Request Details

ParameterDetails
labelDisplays label for shipment. Label must be unique.

barcode

Barcode of shipment. Barcode must be unique.
specimenListIdentifierIdentifier of specimen list which is shipping.
senderSiteSender site name.
receiverSiteReceiver site name.
senderContactPersonSender's user name
receiverContactPersonReceivers user name
sendDateDate of shipping
courierNameCourier name of which shipping sent.
courierTrackingIdCourier tracking identifier for a shipment.
courierTrackingUrlCourier Tracking url.
activityStatusActivity status of shipment. Permissible values are {In Progress, Received, Rejected }

Response :

Response of this event contains details of newly created shipment.

 

Example :

URLhttp://<host>:<port>/catissuecore/rest/ng/shipments
MethodPOST
Content-Typeapplication/json
Request

{
"label" : "Brain Cancer Specimen Lists",
"barcode" : "11111",
"specimenListIdentifier" :1,
"senderSite" : "Site A",
"receiverSite" : "Site B",
"senderContactPerson" : "siteA.admin@admin.com",
"receiverContactPerson" : "siteB.admin@admin.com"
"senderComments" : "comments",
"sendDate" : "2014-01-01",
"courierName" : "xyz",
"courierTrackingId" : "CT123",
"courierTrackingUrl" : "xyz.com"
}

 

 

 

 

 Tissue banks, also known as sites, are interdependent on each other for their biospecimen requirements. These sites interact with each other for various reasons like shipping the specimens from one site to another site. Some sites act as a central repository where other sites store specimens. For that one site can ship specimens and the receiver site will receive the specimens and store in a new location.

Operations on Shipment