catissuecorehttp[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols/title={title}
or
http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols/{distributionprotocolIdid}
Use this resource to patch distribution protocol in the caTissue openSpecimen 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 | principalInvestigator | Name of investigator |
| Titletitle | Title of distribution protocolShort Title | |
| shortTitle | Short Title title of distribution protocol | |
| IRB IDirbId [optional] | IRB ID of of distribution protocol | |
| Start DatestartDate | Starting date of distribution protocol | |
| Number of Specimen AnticipatedanticipatedSpecimenCount | Total count of specimen | |
| Description URLdescriptionUrl [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/title={title}
or
http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/{distributionprotocolIdid}.
Use this URL to patch update distribution protocol in caTissue openSpecimen 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>/openspecimen/rest/ng/distributionprotocols/title={title} or http[s]:<host>:<port>/ catissuecoreopenspecimen/rest/ng/distributionprotocols/{ distributionprotocolIdid} |
| Method | PUT |
| Request | application/json |
| json | { "titleactivityStatus" : "DPProtocolActive" } |
Response | { "principal_investigator" : "Admin Admin", "title" : "DPProtocol", "short_title" : "DPP", "IRB_ID" : "IRB004", "start_date" : "06-10-2014", "number_of_participants _anticipated" : 56, "description_url" : "www.simpleurl.comid: 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 protocol has been patch successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Protocol Nameprotocol name, blank 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 |