Retrieve an Order

This API can be used to retrieve details of an order. Please note, this API response doesn't include the list of distributed specimens. To obtain a list of distributed specimens for a given order, please use https://openspecimen.atlassian.net/wiki/x/TgB3Dw

URL /openspecimen/rest/ng/distribution-orders/{orderId}

Method GET

Response

{
  "id": 1,
  "name": "Test Order",
  "distributionProtocol": {
    "shortTitle": "Test DP"
    /* Other details of DP */
  },
  "requester": { /* either one of the following needs to be specified */
    "id": 3,
    "loginName": "johnd",
    "emailAddress": "johnd@openspecimen.org",
    /* Other details of requester */
  },
  "instituteName": "Institute of Medical Sciences",
  "siteName": "North Hospital Labs",
  "distributor": {
    "id": 4,
    "loginName": "jannied",
    "emailAddress": "jannied@openspecimen.org",
    /* Other details of distributor */
  },
  "trackingUrl": "https://bluedart.com/openspecimen-orders/1/status",
  "comments": "Free text allowing users to add order notes",
  "status": "EXECUTED",
  "creationDate": 1526267841368,
  "executionDate": 1526267841368
}

The path variable orderId should be set to the unique ID of the order whose details are needed.