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

...

Use this resource to get distribution - protocols. This API returns all the distribution - protocols present in the openSpecimen application. 

...

Use this URL to get distribution - protocols in openSpecimen application.

...

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

Below is the example of the get distribution-protocols:

URL

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

or

http://<host>:<port>/openspecimen/rest/ng/distribution-protocols?maxResults={maxResults}

MethodGET
Requestapplication/json

Response

[0]

[{

id: 1
principalInvestigator: 
{
loginName: "admin@admin.com"
domainName: "catissue"
}
-
title: "DPProtocol"
shortTitle: "DP Pro"
irbId: "IRB555571"
startDate: 1402617600000
anticipatedSpecimenCount: 20
descriptionUrl: "www.simplepr.com"
activityStatus: "Active"
},
[1]
{
id: 2
principalInvestigator: 
{
loginName: "admin@admin.com"
domainName: "catissue"
}
-
title: "CP Protocol"
shortTitle: "CP Pro"
irbId: "IRB555571"
startDate: 1402617600000
anticipatedSpecimenCount: 20
descriptionUrl: "www.simplepr.com"
activityStatus: "Active"
}]

 

 

Error Cases :

code
Applies to
Status Message
200All resourcesdistribution - protocols got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations