Versions Compared

Key

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

...

URLhttp://<host>:<port>/openspecimen/rest/ng/visits/bynamespr?visitName=01
MethodGET
Requestapplication/json
Json
Code Block
linenumberstrue
{"visit":
  {
    "eventLabel":"Baseline",
    "eventPoint":10,
    "clinicalDiagnosis":"Not Specified",
    "clinicalStatus":"Not Specified",
    "activityStatus":"Active",
    "code":null,
    "eventId":4,
    "site":"Arkansas Hospital",
    "cpTitle":"Planned Clinical Study",
    "visitDate":1450377000000,
    "cprId":596,
    "status":"Complete"
  },
  "specimens":[
    {
      "initialQty":10,
      "label":null,
      "reqId":4,
      "storageLocation":{id":null,"name":null,"positionX":null,"positionY":null},
      "lineage":"New",
      "concentration":null,
      "status":"Collected",
      "closeAfterChildrenCreation":null,
      "collectionEvent":{"time":"2015-12-08T15:30:36.766Z"},
      "receivedEvent":{"time":"2015-12-08T15:30:36.766Z"},
      "children":[],
      "specimensPool":[]
    }
  ]
}

Response

Code Block
linenumberstrue
{
"visit":  {
"cprId": 596 596
"eventId": 4 4
"ppid":  "DWP00014"
"eventLabel":  "Baseline"
"eventPoint": 10 10
"cpId": 2 2
"cpTitle":  "Planned Clinical Study"
"cpShortTitle":  "A Planned Clinical Study FD"
"id": 726 726
"name":  "DWP00014_Baseline_331"
"clinicalDiagnosis":  "Not Specified"
"clinicalStatus":  "Not Specified"
"activityStatus":  "Active"
"site":  "Arkansas Hospital"
"status":  "Complete"
"comments": null null
"surgicalPathologyNumber": null"sprName": null"missedReason": null"missedBy": null"sprLocked": false"visitDate": 1449595018823"code": null"cohort": null"extensionDetail": null}-"specimens": [1]0:  {"id": 2922"cpId": 2"cprId": 596"eventId": null"visitId": 726"visitName": "DWP00014_Baseline_331""cpShortTitle": "A Planned Clinical Study FD""reqId": 4"sortOrder": null"label": "DWP00014.WB.280""autoPrintLabelEnabled": false"barcode": null"type": "Whole Blood""specimenClass": "Fluid""lineage": "New""anatomicSite": "Not Specified""laterality": "Not Specified""status": "Collected""reqLabel": "EDTA Blood""pathology": "Not Specified""initialQty": 10"availableQty": 10"available": true"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": -1"name": null"positionX": null"positionY": null}-"storageType": "Virtual""collectionContainer": null"activityStatus": "Active""createdOn": 1449594960000"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%""biohazards": [0]"comments": null"closeAfterChildrenCreation": null"children": [1]0:  {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 5"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Derived""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 5"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Virtual""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [5]0:  {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 6"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Aliquot""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 1"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Auto""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PSPEC_LABEL%.%PSPEC_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}-1:  {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 7"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Aliquot""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 1"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Auto""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PSPEC_LABEL%.%PSPEC_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}-2:  {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 8"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Aliquot""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 1"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Auto""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PSPEC_LABEL%.%PSPEC_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}-3:  {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 9"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Aliquot""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 1"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Auto""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PSPEC_LABEL%.%PSPEC_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}[0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}--"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}--"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}--} 

 

 

code
Applies to
Status Message
200All resourcesSpecimen collection groups got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations

 

...

 null
"sprName": null
"missedReason": null
"missedBy": null
"sprLocked": false
"visitDate": 1449595018823
"code": null
"cohort": null
"extensionDetail": null
}
-

"specimens": [
1]0:  {
"id": 2922
"cpId": 2
"cprId": 596
"eventId": null
"visitId": 726
"visitName": "DWP00014_Baseline_331"
"cpShortTitle": "A Planned Clinical Study FD"
"reqId": 4
"sortOrder": null
"label": "DWP00014.WB.280"
"autoPrintLabelEnabled": false
"barcode": null
"type": "Whole Blood"
"specimenClass": "Fluid"
"lineage": "New"
"anatomicSite": "Not Specified"
"laterality": "Not Specified"
"status": "Collected"
"reqLabel": "EDTA Blood"
"pathology": "Not Specified"
"initialQty": 10
"availableQty": 10
"available": true
"concentration": null
"parentId": null
"parentLabel": null
"storageLocation": {
"id": -1
"name": null
"positionX": null
"positionY": null
}
-

"storageType": "Virtual"
"collectionContainer": null
"activityStatus": "Active"
"createdOn": 1449594960000
"code": null
"distributed": null
"collectionEvent": null
"receivedEvent": null
"labelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%"

...


"biohazards": [
0]

...


"comments": null

...


"closeAfterChildrenCreation": null

...


"children": [
1]0:  {
"id": null

...


"cpId": null

...


"cprId": null

...


"eventId": null

...


"visitId": null

...


"visitName": null

...


"cpShortTitle": null

...


"reqId": 5

...


"sortOrder": null

...


"label": null

...


"autoPrintLabelEnabled": false

...


"barcode": null

...


"type": "Plasma"

...


"specimenClass": "Fluid"

...


"lineage": "Derived"

...


"anatomicSite": "Not Specified"

...


"laterality": "Not Specified"

...


"status": null

...


"reqLabel": "Plasma"

...


"pathology": "Not Specified"

...


"initialQty": 5

...


"availableQty": null

...


"available": null

...


"concentration": null

...


"parentId": null

...


"parentLabel": null

...


"storageLocation": {
"id": null

...


"name": null

...


"positionX": null

...


"positionY": null
}

...


-

"storageType": "Virtual"

...


"collectionContainer": "EDTA Vacutainer"

...


"activityStatus": null

...


"createdOn": null

...


"code": null

...


"distributed": null

...


"collectionEvent": null

...


"receivedEvent": null

...


"labelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%"

...


"biohazards": null

...


"comments": null

...


"closeAfterChildrenCreation":

...

 null
"pooledSpecimenId": null
"pooledSpecimenLabel": null
"specimensPool": null
"closeParent": null
"poolSpecimen": false
"extensionDetail": null
}
"pooledSpecimenId": null
"pooledSpecimenLabel": null
"specimensPool": null
"closeParent": null
"poolSpecimen": false
"extensionDetail": null
}

}

 

 

code
Applies to
Status Message
200All resourcesSpecimen collection groups got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations