Versions Compared

Key

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

openspecimen/rest/ng/collection-protocolsprotocol-events/{id}

Use this resource to get collection protocol Event. This API returns the collection protocol event present in the openSpecimen application of given id.

Below are the attributes which need to be sent in the URL:

Parameter
Details
idCollection protocol event id to fetch the collection protocol event

...


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

...

Below is the example of the get collection protocol event:

URL

http://<host>:<port>/openspecimen/rest/ng/collection-protocol-events/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
}



Error Cases :

code
Applies to
Status Message
200All resourcesCollection protocol event got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations