Page Comparison

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

or

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

or

openspecimen/rest/ng/collection-protocols/shortTitle={shortTitle}

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

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

CP shortTitle to fetch the CP

Parameter	Details
idCP	Collection protocol id to fetch the CP
title	CP title to fetch the CP
shortTitle	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/shortTitle={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/shortTitle=SCS_CP

Method GET

Request application/json

Response

Code Block

language	js
theme	Eclipse

{

id: 1

title: "skinCancerStudy"

shortTitle: "SCS_CP"

cpType: "Parent"

startDate: null

endDate: "1995-10-01"

activityStatus: "Active"

labelFormat: null

derivedLabelFormat: null

aliquotLabelFormat: null

ppIdFormat: " "

investigator:

{

loginName: "admin@admin.com"

domainName: "catissue"

}

-

cpSiteRoles:

[

0]

}

linenumbers	true

{
	"id": 1,
    "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,
    "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 1

New Version Current

Key