Get All Collection Protocols

openspecimen/rest/ng/collection-protocols

or

openspecimen/rest/ng/collection-protocols?query={searchString}&title={title}&piId={piId}&repositoryName={repositoryName}&startAt={start}&max={maxResults}&detailedList={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.

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:

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

or

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

Use this URL to get collection protocols in openSpecimen application.

Result:

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

Below is the example of the get all collection protocols:

[
    {
        "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 :