http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/title={distributionprotocolTitle}
or
http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/{distributionprotocolId}
Use this resource to update distribution protocol in the caTissue openSpecimen application. Use HTTP PUT method to call this API by passing the below details in JSON format.
...
Parameter | Details |
|---|---|
| Id | 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>/catissuecoreopenspecimen/rest/ng/distributionprotocols/title={distributionprotocolTitle}
or
http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/{distributionprotocolId}
Use this URL to update distribution protocol in caTissue openSpecimen application.
Result:
The response of this request will contains the details of the updated distribution protocol.
...
| 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 has been update 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 |