Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
Ididentifier of distribution protocol
Principal InvestigatorName of investigator
TitleTitle of distribution protocol
Short TitleShort Title of distribution protocol
IRB IDIRB ID of of distribution protocol
Start DateStarting date of distribution protocol
Number of Specimen AnticipatedTotal count of specimen
Description URL

URL of distribution protocol description

 

http[s]:<host>:<port>/catissuecore/rest/ng/distributionprotocols/{distributionprotocolId}.

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:

 

URLhttp://<host>:<port>/catissuecore/rest/ng/distributionprotocols/{distributionprotocolId}
MethodPUT
Requestapplication/json
json

{

"title" : "DPProtocol"

}

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.com"

}

 

Error Cases :

code
Applies to
Status Message
200All resourcesDistribution Protocol has been patch successfully
400All requestsInvalid parameters, e.g  duplicate Protocol Name, blank Protocol Name etc
401All requestsAuthorization failed, User doesn't have Authority
500All requestsInternal server error, Encountered server error while performing operations