Versions Compared

Key

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

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/title={distributionprotocolTitletitle}

or

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/{distributionprotocolIdid}

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.

Below are the attributes which need to be sent in the request body:

Parameter
Details
Ididentifier Identifier of distribution protocol
Principal InvestigatorName of investigator
TitleTitle of distribution protocol
Short TitleShort Title of distribution protocol
IRB ID [optional]IRB ID of of distribution protocol
Start DateStarting date of distribution protocol
Number of Specimen AnticipatedTotal count of specimen
Description URL [optional]

URL of distribution protocol description

 

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/title={distributionprotocolTitletitle}

or

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/{distributionprotocolIdid}

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

http://<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/title={distributionprotocolTitletitle}

or

http://<host>:<port>/catissuecoreopenspecimen/rest/ng/distributionprotocols/{distributionprotocolIdid}

MethodPUT
Requestapplication/json
json

{
"principal_investigator "principalInvestigator" : {"loginName" : "Admin Adminadmin@admin.com", "titledomainName" :"DPProtocolcatissue"},
"short_title" : "DPPDP Protocol",
"IRB_IDshortTitle" : "IRB004DP Pro",
"start_dateirbId" : "06-10-2014IRB555571",
"number_of_participants _anticipated" : 56startDate" : "2014-06-13",
"description_urldescriptionUrl" : "www.simpleurlsimplepr.com",
"anticipatedSpecimenCount" : 20,
"activityStatus" : "Active"
}

Response

{"

id
":1,

"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
20
principalInvestigator
{
loginName"admin@admin.com"
domainName"catissue"
}
-
title"DP Protocol"
shortTitle"DP Pro"
irbId"IRB555571"
startDate1402617600000
anticipatedSpecimenCount20
descriptionUrl"www.simplepr.com"
activityStatus"Active"
}

 

Error Cases :

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