openspecimen/rest/ng/distributionprotocols
...
Below are the attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
| principalInvestigator | Name of investigator |
| title | Title of distribution protocol |
| shortTitle | Short Title title of distribution protocol |
| irbId [optional] | IRB ID of of distribution protocol |
| startDate | Starting date of distribution protocol |
| anticipatedSpecimenCount | Total count of specimen |
| descriptionUrl [optional] | URL of distribution protocol description |
| activityStatus | Defines the status of a distribution protocol record {active, closed, pending, disabled} |
...
| URL | http://<host>:<port>/openspecimen/rest/ng/distributionprotocols |
| Method | POST |
| Request | application/json |
| json | { "title" : "DP Protocol", "shortTitle" : "DP Pro", "irbId" : "IRB555571", "startDate" : "2014-06-13", "descriptionUrl" : "www.simplepr.com", "anticipatedSpecimenCount" : 20, "activityStatus" : "Active" |
Response | { id: 20 title: "DP Protocol" shortTitle: "DP Pro" irbId: "IRB555571" startDate: 1402617600000 anticipatedSpecimenCount: 20 activityStatus: "Active" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Distribution protocol has been created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate protocol Name, blank protocol name etc |
| 401 | All requests | Authorization failed, User user doesn't have Authority |
| 500 | All requests | Internal server error, Encountered server error while performing operations |