Versions Compared

Old Version 5

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

Saved on

compared with

New Version Current

changes.mady.by.user Vinayak Pawar

Saved on

Key

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

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

...

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

Use this resource to get distribution protocol. This API returns distribution - protocol present in the openSpecimen applicationOpenSpecimen database. Use HTTP GET method to call this API by passing the below details in JSON format.

...

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

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

Result:

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

Below is the example of the get distribution-protocol :


URL

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

or

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

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 resourcesSuccess. The response body contains the distribution - protocol got successfullydetails.
401All requestsAuthorization failed, user doesn’t have authoritysufficient rights.
500All requestsInternal server error, encountered server error while performing operationsEncountered unhandled server error when retrieving the distribution protocol details.