Versions Compared

Old Version 2

changes.mady.by.user Darpan Patil (Deactivated)

Saved on

compared with

New Version 3

changes.mady.by.user Darpan Patil (Deactivated)

Saved on

Key

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

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

Use this resource to get distribution - protocol. This API returns distribution-protocol present in the openSpecimen application. 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
distribution-protocolIdiddistribution - protocol id to fetch the distribution-protocol

...

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

Use this URL to get distribution-protocol by an id in openSpecimen application.

...

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

Below is the example of the get distribution-protocol :

URL

http://<host>:<port>/openspecimen/rest/ng/distribution-protocols/20

MethodGET
Requestapplication/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
200All resourcesdistribution-protocol got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations