Versions Compared

Key

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

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

Use this resource to get collection protocol. This API returns the collection protocol present in the openSpecimen application of given id.

Below are the attributes which need to be sent in the URL:

Parameter
Details
idCollection protocol id to fetch the collection protocol


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

Use this URL to get collection protocol by an id in openSpecimen application

Result:

The response of this request will contains the details of the collection protocol.

Below is the example of the get collection protocol:

URL

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

MethodGET
Requestapplication/json

Response

Code Block
languagejs
themeEclipse
linenumberstrue
{
	"id": 291,
    "shortTitle": "VCB Collection",
    "title": "VCB Collection",
    "code": null,
    "principalInvestigator": {
    	"id": 104,
        "firstName": "Paleracio",
        "lastName": "Nina",
        "loginName": "ninapaleracio",
        "domain": null,
        "emailAddress": null,
        "admin": null,
        "cpCount": 0,
        "creationDate": null
    },
    "startDate": 1435602600000,
    "endDate": null,
    "participantCount": 3,
    "specimenCount": 34,
    "ppidFmt": "",
    "manualPpidEnabled": false
}

 

Error Cases :

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