Page Comparison

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

or

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

or

openspecimen/rest/ng/collection-protocols?query={search string}

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

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

Collection protocol title query

Parameter	Details
id	Collection protocol id to fetch the collection protocol	title	to fetch the collection protocol		Collection protocol shortTitle to fetch the collection protocol

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

or

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

or

http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols?query={shortTitle}

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

or

http://<host>:<port>/openspecimen/rest/ng/collection-protocols?title= skinCancerStudy

or

http://<host>:<port>/openspecimen/rest/ng/collection-protocols?query=SCS_collection protocol

Method GET

Request application/json

Response

Code Block

language

{

id: 1

title: "skinCancerStudy"

shortTitle: "SCS_collection protocol"

collection protocolType: "Parent"

startDate: null

endDate: "1995-10-01"

activityStatus: "Active"

labelFormat: null

derivedLabelFormat: null

aliquotLabelFormat: null

ppIdFormat: " "

investigator:

{

loginName: "admin@admin.com"

domainName: "catissue"

}

js
theme	Eclipse
linenumbers	true

{
	"id": 29,
    "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
200	All resources	Collection protocol got successfully
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations

Versions Compared

Old Version 5

New Version 6

Key