Versions Compared

Key

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

...

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

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 created successfully.
400All requestsInvalid parameters, e.g Invalid User-ids, Invalid Specimen-ids, Null or empty label.
401All requestsAuthorization failed, User doesn’t have Authority.
500All requestsInternal server error, Encountered server error while performing operations.