http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols/title={distributionprotocolTitletitle}
or
http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols/{distributionprotocolIdid}
Use this resource to update distribution protocol in the openSpecimen application. Use HTTP PUT 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 |
|---|---|
| Id | identifier Identifier of distribution protocol |
| Principal Investigator | Name of investigator |
| Title | Title of distribution protocol |
| Short Title | Short Title of distribution protocol |
| IRB ID [optional] | IRB ID of of distribution protocol |
| Start Date | Starting date of distribution protocol |
| Number of Specimen Anticipated | Total count of specimen |
| Description URL [optional] | URL of distribution protocol description |
http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols/title={distributionprotocolTitletitle}
or
http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols/{distributionprotocolIdid}
Use this URL to update distribution protocol in openSpecimen application.
...
| URL |
or
|
| Method | PUT |
| Request | application/json |
| json | { |
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 protocol has been update successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Protocol Nameprotocol 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 |