Page Comparison

openspecimen/rest/ng/collection-protocols

or

openspecimen/rest/ng/collection-protocols?query={searchString}&title={title}&piId={searchString}

or

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

or

openspecimen/rest/ng/collection-protocols?searchString={searchString}&maxResults={maxResultspiId}&repositoryName={repositoryName}&startAt={start}&max={maxResults}&detailedList={true/false}

Use this resource to get All CPs. User can also specify the search string which will be used to match the shot titles. collection protocols. This API returns all the matching collection protocols based on the searchString, if searchString not specified then it returns all the collection protocols present in the openSpecimen application.

Use HTTP GET method to call this API by passing the below details in JSON format.

...

Below are the attributes which need to be sent in the request body:

Parameter	Details
searchString	String for search condition to get the CPs	maxResults	Integer value to get maximum records[optional]	The value with which you want to search the collection protocol. The given value will be matched with Title and Short Title.
title[optional]	Collection Protocol title or short title
piId[optional]	Id of principal investigator
repositoryName[optional]	Name of repository
startAt [optional]	start index of the results
maxResults [optional]	Maximum number of records to fetch. By default it will be 1000

...

detailedList [

...

optional]

Set this parameter to true, if want to collection protocol in detail

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

or

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

or

http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols?maxResultsstart}&max={maxResults}&searchString={searchString}&countReq={true/false}

Use this URL to get CPs collection protocols in openSpecimen application.

...

The response of this request will contains the details of the CPscollection protocols.

Below is the example of the get CPsall collection protocols:

[{

id: 1

shortTitle: "SCS_CP"

title: "skinCancerStudy"

ppidFormat: " "

} {

id: 63

shortTitle: "scg1"

title: "scg1"

ppidFormat: null

} {

id: 83

shortTitle: "SP test"

title: "SP test"

ppidFormat: " "

} {

id: 101

shortTitle: "SuperTest"

title: "SuperTest"

ppidFormat: " "

} {

id: 102

shortTitle: "Super2"

title: "SuperTest2"

ppidFormat: " "

} {

id: 113

shortTitle: "Southern Health Protocol"

title: "Southern Health Protocol"

ppidFormat: ""SHP%05d",PPID"

}{

id: 121

shortTitle: "St Vincent Protocol"

title: "St Vincent Protocol"

ppidFormat: " "

} {

id: 126

shortTitle: "SCS_CPa1"

title: "skinCancerStudy2"

ppidFormat: " "

}]

URL	`http://<host>:<port>/`openspecimen/rest/ng/collection-protocols?maxResultsquery=2vcb&searchStringdetailedList=strue
Method	GET
Request	application/json
Response	[{ id: 1 shortTitle: "SCS_CP" title: "skinCancerStudy" ppidFormat: " " } { id: 63 shortTitle: "scg1" title: "scg1" ppidFormat: null } ]
URL	`http://<host>:<port>/`openspecimen/rest/ng/collection-protocols?searchString=s
Method	GET
Request	application/json
Response

Code Block

language	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	CPs Collection protocols 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