You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 7
Next »
Summary
This page contains documentation of create shipment REST API.
Request Details
| Parameter | Details |
|---|
| label | Displays label for shipment. Label must be unique. |
barcode | Barcode of shipment. Barcode must be unique. |
| specimenListIdentifier | Identifier of specimen list which is shipping. |
| senderSite | Sender site name. |
| receiverSite | Receiver site name. |
| senderContactPerson | Sender's user name |
| receiverContactPerson | Receivers user name |
| sendDate | Date of shipping |
| courierName | Courier name of which shipping sent. |
| courierTrackingId | Courier tracking identifier for a shipment. |
| courierTrackingUrl | Courier Tracking url. |
| activityStatus | Activity status of shipment. Permissible values are {In Progress, Received, Rejected } |
Response :
Response of this event contains details of newly created shipment.
Example :
| URL | http://<host>:<port>/catissuecore/rest/ng/shipments |
| Method | POST |
| Content-Type | application/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"
} |
| Response |
{
"id" : 1,
"label" : "Brain Cancer Specimen Lists",
"barcode" : "11111",
"specimenListDetails" : {
"id": 12,
"label": "Frozen Specimen - SP12314"
},
{
"id": 13,
"label": "Frozen Specimen - SP12315"
} ,
"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"
}
|