Versions Compared

Key

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

openspecimen/rest/ng/collection-protocol-events/1{eventId}

Use this resource to update collection protocol eventĀ in the OpenSpecimen application. Use HTTP POST 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
eventIdCollection Protocol Event id to be delete
eventLabelevent label
eventPointevent point (in days)
collectionProtocolcollection protocol name
defaultSitedefault site name
clinicalDiagnosisclinical disgnosis, value should be exist in PV's
clinicalStatusclinical status, value should be exist in PV's
activityStatusactivity status
code[optional]event code, it is unique in given collection protocol

...

URLhttp://<host>:<port>/openspecimen/rest/ng/collection-protocol-events/1
MethodPOST
Requestapplication/json
json
Code Block
languagejs
themeEclipse
linenumberstrue
{
    "activityStatus": "Active",
    "clinicalDiagnosis": "8551/3 Acinar cell cystadenocarcinoma",
    "clinicalStatus": "Operative",
    "code": null,
    "collectionProtocol": "BocaBiosciences CP",
    "defaultSite": "Bocabio Collection Site",
    "eventLabel": "Base visit",
    "eventPoint": 0
}

Response

Code Block
languagejs
themeEclipse
linenumberstrue
{
    "id": 1,
    "activityStatus": "Active",
    "clinicalDiagnosis": "8551/3 Acinar cell cystadenocarcinoma",
    "clinicalStatus": "Operative",
    "code": null,
    "collectionProtocol": "BocaBiosciences CP",
    "defaultSite": "Bocabio Collection Site",
    "eventLabel": "Base visit",
    "eventPoint": 0
}

...