catissuecore/rest/ng/storage-containers/{containerId}
Use this resource for update the Storage Container. Use HTTP PUT method to call this API by passing the below details in JSON format.
containerId | id of storage container to be updated |
name | Container Name. It should be unique in application |
barcode | Container Barcode |
activityStatus | Activity Status of container |
tempratureInCentigrade | Temperature of storage container. |
siteName | Site name in which the container is present |
parentContainerDetails[Optional] | Details of parent container, having parameters like, name, barcode etc. By default is will be null |
specimenPositionDetails | It is collection of details object which contains the information of specimens and their positions having following parameters specimenName - name of specimen positionDimensionOne - Position one of specimen in container positionDimensionTwo - Position two of specimen in container positionDimensionOneString - Name given to position dimension one string eg. row positionDimensionTwoString - Name given to position dimension two string eg. column |
cpNameCollection | Name of collection protocols to restrict specific protocol for storage |
holdsSpecimenClassCollection | Name of specimen classes which container holds. |
holdsSpecimenTypeCollection | Name of specimen types which container holds |
capacityDetails | Details object of Storage container capcity, Contains following parameters oneDimensionCapacity - Max capacity of dimension one eg.30 twoDimensionCapacity - Max capacity of dimension two eg.30 |
comments [optional] | Comments for container, By default it will be null |
Parameter | Details |
---|
http[s]:<host>:<port>/catissuecore/rest/ng/storage-containers/{containerId}
Use this URL to update Storage Container in caTissue application.
Result:
The response of this request will contains the details of the updated Storage Container.
Below is the example of the update Storage Container:
URL | http://<host>:<port>/ catissuecore/rest/ng/storage-containers/{containerId} |
Method | PUT |
Request | application/json |
json | { "id" : 1, "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerDetails":{ "name":"Freezer", "barcode":"2-edpwesdadas", "activityStatus":"Active", "specimenPositionDetails":[], "cpNameCollection":["Cp1","My CP"], "holdsSpecimenClassCollection":["Cell","Tissue","Fluid"], "holdsSpecimenTypeCollection":["Serum","Fixed Tissue Slide","Whole Blood"], "comment":"Blah blah blah", "capacityDetails":{ "id" : 1, "oneDimensionCapacity":10, "twoDimensionCapacity":10 } }, "specimenPositionDetails":[ { "id" : 1, "specimenName":"Myspecimen1", "positionDimensionOne":1, "positionDimensionTwo":2, "positionDimensionOneString":"row", "positionDimensionTwoString":"column" } ], "cpNameCollection":["Cp1","My CP"], "holdsSpecimenClassCollection":["Cell","Tissue","Fluid"], "holdsSpecimenTypeCollection":["Serum","Fixed Tissue Slide","Whole Blood"], "comment":"Blah blah blah", "capacityDetails":{ "id" : 1, "oneDimensionCapacity":10, "twoDimensionCapacity":10} } |
Response | { "id" : 1, "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "tempratureInCentigrade":22.22, "siteName":"My Site", "parentContainerDetails":{ "name":"Freezer", "barcode":"2-edpwesdadas", "activityStatus":"Active", "specimenPositionDetails":[], "cpNameCollection":["Cp1","My CP"], "holdsSpecimenClassCollection":["Cell","Tissue","Fluid"], "holdsSpecimenTypeCollection":["Serum","Fixed Tissue Slide","Whole Blood"], "comment":"Blah blah blah", "capacityDetails":{ "id" : 1, "oneDimensionCapacity":10, "twoDimensionCapacity":10 } }, "specimenPositionDetails":[ { "id" : 1, "specimenName":"Myspecimen1", "positionDimensionOne":1, "positionDimensionTwo":2, "positionDimensionOneString":"row", "positionDimensionTwoString":"column" }, { "id" : 2, "specimenName":"Myspecimen2", "positionDimensionOne":2, "positionDimensionTwo":2, "positionDimensionOneString":"row", "positionDimensionTwoString":"column" } ], "cpNameCollection":["Cp1","My CP"], "holdsSpecimenClassCollection":["Cell","Tissue","Fluid"], "holdsSpecimenTypeCollection":["Serum","Fixed Tissue Slide","Whole Blood"], "comment":"Blah blah blah", "capacityDetails":{ "id" : 1, "oneDimensionCapacity":20, "twoDimensionCapacity":20 } } |
Error Cases :
code | Applies to | Status Message |
---|---|---|
200 | All resources | Storage Container has been updated successfully |
400 | All requests | Invalid parameters, e.g duplicate Container Name, blank Container Name etc |
401 | All requests | Authorization failed, User doesn’t have Authority |
404 | All requests | Container not found, Container with given details not present in the system |
500 | All requests | Internal server error, Encountered server error while performing operations |