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.
...
| Parameter | Details |
|---|---|
| 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. |
receivingSite | Receiver site name. |
notifyUsers | Collection of users to be notified |
shippedDate | Date of shipping |
senderComments | Sender comments |
status | Activity status Status of shipment. Permissible values are {Pending, Shipped , Received } |
sender | Sender of the shipment |
shipmentItemshipmentItems | Collection of specimens |
Response :
Response of this event contains details of newly created shipment.
...
label: specimen label |
http[s]:<host>:<port>/openspecimen/rest/ng/shipments
Use this URL to create shipment in the OpenSpecimen application.
Result:
The response of this request will contains the details of the created shipment
Below is the example of the create shipment
| URL | http://<host>:<port>/catissuecoreopenspecimen/rest/ng/shipments |
| Method | POST |
| Content-Type | application/json |
| Request | { |
| Response |
|
...