http[s]:<host>:<port>/catissuecore/rest/ng/distributionprotocols/title={distributionprotocolTitle}
or
http[s]:<host>:<port>/catissuecore/rest/ng/distributionprotocols/{distributionprotocolId}
Use this resource to patch distribution protocol in the caTissue application. Use HTTP PATCH 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 of distribution protocol |
| Principal Investigator | Name of investigator |
| Title | Title of distribution protocol |
| Short Title | Short Title of distribution protocol |
| IRB ID | IRB ID of of distribution protocol |
| Start Date | Starting date of distribution protocol |
| Number of Specimen Anticipated | Total count of specimen |
| Description URL | URL of distribution protocol description |
http[s]:<host>:<port>/catissuecore/rest/ng/distributionprotocols/title={distributionprotocolTitle}
or
http[s]:<host>:<port>/catissuecore/rest/ng/distributionprotocols/{distributionprotocolId}
Use this URL to update distribution protocol in caTissue application.
Use this URL to patch distribution protocol in caTissue application.
Result:
The response of this request will contains the details of the patch distribution protocol.
Below is the example of the update distribution protocol:
| URL | http[s]:<host>:<port>/catissuecore/rest/ng/distributionprotocols/title={distributionprotocolTitle} or http[s]:<host>:<port>/catissuecore/rest/ng/distributionprotocols/{distributionprotocolId} Use this URL to update distribution protocol in caTissue application.
|
| Method | PUT |
| Request | application/json |
| json | { "activityStatus" : "Active" } |
Response | { id: 20 title: "DP Protocol" shortTitle: "DP Pro" irbId: "IRB555571" startDate: "2014-06-13" anticipatedSpecimenCount: 20 activityStatus: "Active" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Distribution Protocol has been patch 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 |