Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Summary

This page contains documentation for deleting Shipment.

 

Request Details

ParameterDetails
shipmentIdIdentifier of shipment

Result

Response will contain details of deleted shipment

 

URLhttp://<host>:<port>/catissuecore/rest/ng/shipments/{id}
MethodDELETE
Content-Typeapplication/json
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"
}

 

Error Cases

code
Applies to
Status Message
200All resourcesShipment has been updated successfully.
400All requestsInvalid parameters, e.g Invalid shipment id.
401All requestsAuthorization failed, User doesn’t have Authority.
500All requestsInternal server error, Encountered server error while performing operations.