Versions Compared

Key

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

catissuecore/rest/ng/distributionprotocols

...

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

Parameter
Details
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

...

URLhttp://<host>:<port>/catissuecore/rest/ng/distributionprotocols
MethodPOST
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

{

id20
principalInvestigator
{

"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
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 created 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