Summary
...
http[s]:<host>:<port>/
...
openspecimen/rest/ng/
...
sites
Use this resource to create shipment in the openSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.
Below are the attributes which need to be sent in the request body:
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. | |
| name | Name of the shipment | |
courierName | Courier name of which shipping sent | |
trackingNumber | Courier tracking number for a shipment. | |
trackingUrl | Courier tracking URL | |
sendingSite | Sender site name. | |
receiverSitereceivingSite | Receiver site name. | |
| senderContactPerson | Sender's user name | |
| receiverContactPerson | Receivers user name | |
| sendDate | notifyUsers | Collection of users to be notified |
shippedDate | Date of shipping | |
| courierName | Courier name of which shipping sent. | |
| courierTrackingId | Courier tracking identifier for a shipment. | |
| courierTrackingUrl | Courier Tracking url. | |
| activityStatus | senderComments | Sender comments |
status | Activity status of shipment. Permissible values are {In ProgressPending, Shipped, Received , Rejected }} | |
sender | Sender of the shipment | |
shipmentItem | Collection of specimens |
Response :
Response of this event contains details of newly created shipment.
...