Versions Compared

Key

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

URL: http[s]:<host>:<port>/openspecimen/rest/ng/shipments/{id}

...

Expand
titleUpdating a shipment...

URL

http[s]://<host>:<port>/openspecimen/rest/ng/shipments/{id}

Method

PUT

Content-Type

application/JSON

Request

Code Block
languagejson
{
  "name":"Testing_Shipment_#14",
  "type":"SPECIMEN",
  "courierName":"FedEx",
  "trackingNumber":"FedEx#14",
  "trackingUrl":null,
  "sendingSite":"Pune Site",
  "receivingInstitute":"USB",
  "receivingSite":"Applied Research",
  "shippedDate":1591697659000,
  "status":"Pending",
  "sender":{
    "emailAddress":"admin@localhost"
  },
  "senderComments":"Handle with care. (Edit#2: Added more Specimen)",
  "activityStatus":"Active",
  "shipmentSpmns":[
    {
      "specimen":{
        "label":"TCP_TBS_4.D1.A14"
      }
    },
    {
      "specimen":{
        "label":"TCP_TBS_4.D1.A15"
      }
    }
  ],
  "shipmentContainers":[],
  "notifyUsers":[
    {
      "emailAddress":"admin@localhost"
    }
  ]
}

Response

Code Block
languagejson
{
  "id": 15,
  "name": "Testing_Shipment_#14",
  "type": "SPECIMEN",
  "courierName": "FedEx",
  "trackingNumber": "FedEx#14",
  "trackingUrl": null,
  "sendingSite": "Pune Site",
  "receivingInstitute": "USB",
  "receivingSite": "Applied Research",
  "shippedDate": 1591697659000,
  "sender": {
    "id": 2,
    "type": "SUPER",
    "firstName": "System",
    "lastName": "Administrator",
    "loginName": "admin",
    "domain": "openspecimen",
    "emailAddress": "admin@localhost",
    "instituteName": "USB",
    "primarySite": "Site BO 1",
    "admin": true,
    "instituteAdmin": false,
    "manageForms": true,
    "cpCount": 0,
    "creationDate": null,
    "activityStatus": "Active"
  },
  "senderComments": "Handle with care. (Edit#2: Added more Specimen)",
  "receivedDate": null,
  "receiver": null,
  "receiverComments": null,
  "status": "Pending",
  "activityStatus": "Active",
  "shipmentSpmns": [],
  "shipmentContainers": [],
  "notifyUsers": [
    {
      "id": 2,
      "type": "SUPER",
      "firstName": "System",
      "lastName": "Administrator",
      "loginName": "admin",
      "domain": "openspecimen",
      "emailAddress": "admin@localhost",
      "instituteName": "USB",
      "primarySite": "Site BO 1",
      "admin": true,
      "instituteAdmin": false,
      "manageForms": true,
      "cpCount": 0,
      "creationDate": null,
      "activityStatus": "Active"
    }
  ],
  "specimensCount": null,
  "request": null,
  "shipmentSpecimen": null,
  "shipmentContainer": null,
  "sendMail": true,
  "mergeKey": "Testing_Shipment_#14"
}

...