Summary
This page contains documentation on updating the specimen list items.
Request Details
Parameter | Details |
|---|---|
| specimenListId | Identifier of the specimen. |
| operation | Can be one of the following. UPDATE , REMOVE , ADD . Using UPDATE will clear off the existing list of specimens and add the new specimens specified in payload. Using ADD will append the specimens to existing list of specimens. Using REMOVE will remove the specimens mentioned in payload from the existing list. This field is optional, if this field is not mentioned, default value is taken as UPDATE. |
| Request Payload | Is list of Specimen identifiers. |
Endpoint and Payload details
The response of this request will contain the summary of specimens belong to specimen list identified by 'specimenListId'. It contains summary of specimens belonging to a specimen-list in case of UPDATE operation. In case of ADD operation the response is summary of specimens that have been newly added, similarly in case of REMOVE response is summary of specimens which have been removed from the list.
| URL | http://<host>:<port>/catissuecore/rest/ng/specimen-lists/{specimenListId}/specimens?operation=[UPDATE|REMOVE|ADD] |
| Method | PUT |
| Content-Type | application/json |
| Request | [ 15, 16, 17] |
| Response | [ { "id": 15, "label": "SSCP Spec 1213" }, { "id": 16, "label": "SSCP Spec 1213" }, { "id": 17, "label": "SSCP Spec 1213" } ] |
Error Cases
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Specimen-list has updated successfully. |
| 400 | All requests | Invalid parameters, i.e. invalid specimen-list id. |
| 401 | All requests | Authorization failed, User doesn’t have Authority. |
| 500 | All requests | Internal server error, Encountered server error while performing operations |