POST openspecimen/rest/ng/distributionprotocolsdistribution-protocols
Use this resource to create new distribution protocol in the openSpecimen OpenSpecimen application. Use HTTP POST 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 | ||||
|---|---|---|---|---|---|
| principalInvestigator | Name of investigator | ||||
| title | Title of distribution protocol | ||||
| shortTitle | Short Title of distribution protocoltitle of distribution protocol | ||||
| principalInvestigator | Principal Investigator user details. This is the JSON format object with following details:
| ||||
| instituteName | Receiving institute for which the distribution protocol will be used. | ||||
| defReceivingSiteName [optional] | Default receiving site name under receiving institute. | ||||
| irbId [optional] | IRB ID of of distribution protocol | ||||
| startDate [optional] | Starting date of distribution protocol | ||||
| anticipatedSpecimenCount | Total count of specimen | ||||
| descriptionUrl [optional] | URL of distribution protocol description | ||||
| activityStatusendDate [optional] | End date of distribution protocol. | ||||
| report [optional] | This is the JSON format object for order report query. The required field for report is id (identifier) of query. | ||||
| distributingSites | This is the JSON object of distributing site details the object format is institute name : array of siteName. Example: "{"institute1": ["Site1", "Site2"], "institute2": []}"The empty array for site names represent "All current & future sites". | ||||
| activityStatus [optional] | Defines the status of a distribution protocol record {active, closed, pending, disabled}. The default value will be "Active". |
POST http[s]:<host>:<port>/openspecimen/rest/ng/distributionprotocolsdistribution-protocols
Use this URL to add distribution protocol in openSpecimen OpenSpecimen application.
Result:
The response of this request will contains the details of the created distribution protocol.
Below is the example of the create distribution protocol:
| URL | http://<host>:<port>/openspecimen/rest/ng/distributionprotocolsdistribution-protocols |
| Method | POST |
| Request | application/json |
| json | { "principalInvestigatortitle" : {"loginName"DP Protocol", "shortTitle" : "admin@admin.comDP Pro", "domainName "titleinstituteName": "DP ProtocolInstitute1", "shortTitle defReceivingSiteName": "DP ProSite1", "irbId" : "IRB555571", "startDate" : "2014-06-13", "descriptionUrlendDate": "www.simplepr.com2015-10-01", "anticipatedSpecimenCountdistributingSites": 20,{"activityStatusInstitute2": ["Active"Site4", "Site5"]} |
Response | { { loginName: "DP Protocol", domainName: "catissue" } title: "DP Protocol" shortTitle: "DP Pro" irbId: "IRB555571" startDate: 1402617600000 anticipatedSpecimenCount: 20 activityStatus: "Active" "Site5" |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Distribution protocol has been created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate 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 |