Summary
This page contains documentation of create shipment REST API. You can use http[s]:<host>:<port>/catissuecore/rest/ng/shipments url to create shipment.
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 | { |
| Response |
|
Error Cases
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Shipment has been created successfully. |
| 400 | All requests | Invalid parameters, e.g Invalid Users , Invalid Specimen-List id, Null or empty label,barcode. |
| 401 | All requests | Authorization failed, User doesn’t have Authority. |
| 500 | All requests | Internal server error, Encountered server error while performing operations. |