Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Update Distribution Protocol

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

or

http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols/{id}

Use this resource to update  distribution protocol in the 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 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>/openspecimen/rest/ng/distributionprotocols/title={title}

or

http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocols/{id}

Use this URL to update distribution protocol in openSpecimen application.

 

Result:

The response of this request will contains the details of the updated distribution protocol.

Below is the example of the update distribution protocol:

 

URL

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

or

http://<host>:<port>/openspecimen/rest/ng/distributionprotocols/{id}

MethodPUT
Requestapplication/json
json

{
"principalInvestigator" : {"loginName" : "admin@admin.com", "domainName" :"catissue"},
"title" : "DP Protocol",
"shortTitle" : "DP Pro",
"irbId" : "IRB555571",
"startDate" : "2014-06-13",
"descriptionUrl" : "www.simplepr.com",
"anticipatedSpecimenCount" : 20,
"activityStatus" : "Active"
}

Response

{

id20
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 has been update 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
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com