Page Comparison

openspecimen/rest/ng/collection-protocols

...

openspecimen/rest/ng/collection-protocols?startquery={searchString}&title={title}&piId={piId}&repositoryName={startrepositoryName}&maxstartAt={maxResultsstart}&searchStringmax={searchStringmaxResults}&countReqdetailedList={true/false}

Use this resource to get 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.

...

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

chkPrivilege [optional]

Parameter	Details	Whether to return the CP's as per user's privileges. By default this API will return list of CP's on which user actually has access. If need all CP's then set this attribute to false.
searchString [optional]	The value with which you want to search the collection protocol. The given value will be matched with Title and Short Title.start
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
countReq detailedList [optional]	Set this parameter to true, if want to get the total count of matching results.collection protocol in detail

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

...

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

Method GET

Request application/json

Response

Code Block

language	js
theme	Eclipse
linenumbers	true

{

id: 1

shortTitle: "SCS_CP"

title: "skinCancerStudy"

ppidFormat: " "

}]


    {
        "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 3

New Version Current

Key