Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Parameter
Details
cpIdCollection protocol id

 


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

...

Below is the example of the get all collection protocols:

URLhttp://<host>:<port>/openspecimen/rest/ng/collection-
protocols
protocol-events?cpId=1
MethodGET
Response


Code Block
languagejs
themeEclipse
linenumberstrue
[{
    "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
200All resourcesCollection protocol Events got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations