Get All Collection Protocol Events

openspecimen/rest/ng/collection-protocol-events?cpId={cpId}

Use this resource to get collection protocol Events. This API returns all the matching collection protocols based on the collection protocol id 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
cpId	Collection protocol id

http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocol-events?cpId={cpId}

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:

URL http://<host>:<port>/openspecimen/rest/ng/collection-protocol-events?cpId=1

Method GET

Response

[{
    "id": 4,
    "eventLabel": "Baseline",
    "eventPoint": 10,
    "collectionProtocol": "Planned Clinical Study",
    "defaultSite": "Arkansas Hospital",
    "clinicalDiagnosis": "Not Specified",
    "clinicalStatus": "Not Specified",
    "activityStatus": "Active",
    "code": null,
    "specimenRequirements": null
},{
    "id": 5,
    "eventLabel": "Surgery",
    "eventPoint": 30,
    "collectionProtocol": "Planned Clinical Study",
    "defaultSite": "Arkansas Hospital",
    "clinicalDiagnosis": "Not Specified",
    "clinicalStatus": "Not Specified",
    "activityStatus": "Active",
    "code": null,
    "specimenRequirements": null
},{
    "id": 6,
    "eventLabel": "Post Surgery",
    "eventPoint": 45,
    "collectionProtocol": "Planned Clinical Study",
    "defaultSite": "Arkansas Hospital",
    "clinicalDiagnosis": "Not Specified",
    "clinicalStatus": "New Diagnosis",
    "activityStatus": "Active",
    "code": null,
    "specimenRequirements": null
}]

Error Cases :

code	Applies to	Status Message
200	All resources	Collection protocol Events got successfully
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations