Get Distribution Protocol

openspecimen/rest/ng/distribution-protocols/{id}

or

openspecimen/rest/ng/distribution-protocols?title={title}

Use this resource to get distribution protocol. This API returns distribution protocol present in the OpenSpecimen database. Use HTTP GET 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
id	distribution protocol id to fetch the distribution-protocol
title	distribution protocol title to fetch the distribution-protocol

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

or

http[s]:<host>:<port>/openspecimen/rest/ng/distribution-protocols?title={title}

Use this URL to get distribution protocol by an ID in OpenSpecimen application.

Result:

The response contains the details of the requested distribution protocol.

URL	`http://<host>:<port>/`openspecimen/rest/ng/distribution-protocols/20 or `http://<host>:<port>/`openspecimen/rest/ng/distribution-protocols?title=DP Protocol
Method	GET
Request	application/json
Response	{ id: 20 principalInvestigator: { loginName: "admin@admin.com" domainName: "catissue" } title: "DP Protocol" shortTitle: "DP Pro" irbId: "IRB555571" startDate: 1402617600000 anticipatedSpecimenCount: 20 descriptionUrl: "www.simplepr.com" activityStatus: "Active" }

Error Cases :

code	Applies to	Status Message
200	All resources	Success. The response body contains the distribution protocol details.
401	All requests	Authorization failed, user doesn’t have sufficient rights.
500	All requests	Encountered unhandled server error when retrieving the distribution protocol details.