Versions Compared

Version Old Version 1 New Version Current
Changes made by

Vinayak Lonushte (Unlicensed)

Kaustubh Wadagavi

Saved on

Key

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

openspecimen/rest/ng/collection-protocolsprotocol-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.

...

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

URLhttp://<host>:<port>/openspecimen/rest/ng/collection-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