openspecimen/rest/ng/distributionprotocols
Use this resource to create new distribution protocol in the openSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.
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 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} |
http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols
Use this URL to add distribution protocol in openSpecimen application.
Result:
The response of this request will contains the details of the created distribution protocol.
Below is the example of the create distribution protocol:
| 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 doesn't have Authority |
| 500 | All requests | Internal server error, Encountered server error while performing operations |