Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Update Collection Protocol Event

openspecimen/rest/ng/collection-protocol-events/{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

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

Use this URL to update collection protocol event in the OpenSpecimen application.

Result:

The response of this request will contains the details of the updated collection protocol event

Below is the example of the update collection protocol event:

URLhttp://<host>:<port>/openspecimen/rest/ng/collection-protocol-events/1
MethodPOST
Requestapplication/json
json
{
    "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

{
    "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
}

 Error Cases :

code
Applies to
Status Message
200All resourcesCollection Protocol Event has been created successfully
400All requestsInvalid parameters, e.g  duplicate event label, blank event label etc
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com