Page Comparison

...

openspecimen/rest/ng/collection-protocols?query={searchString}&title={title}&piId={piId}&repositoryName={repositoryName}&startstartAt={start}&max={maxResults}&detailedList={true/false}

...

Parameter	Details
searchString [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
start 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

...

URL http://<host>:<port>/openspecimen/rest/ng/collection-protocols?query=vcb&detailedList=true

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	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 5

New Version Current

Key