Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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"
}

 

 

 

 

 

  • No labels