Page Comparison

openspecimen/rest/ng/storage-containers/{id}

Use this resource for update the storage container. Use HTTP PUT 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

Parameter

Details

name Container name. It should be unique in application

barcode [Optional] Container barcode, By default it will be null. It should be unique in application if barcode is provided

typeName [Optional] Container type name.

siteName Site name in which the container is present

storageLocation [Optional]

In case of child level container, specify position of the container within parent container.

id	Identifier of the parent container
name	Name of the parent container.
positionX	Column position
positionY	Row position

noOfRows Number of rows in container

noOfColumns Number of columns in conatiner

rowLabelingScheme [Optional]

Row labeling scheme, by default it will be Numbers.

Available permissible values are :

{Numbers, Alphabets Upper Case, Alphabets Lower Case, Roman Upper Case, Roman Lower Case}

columnLabelingScheme [Optional]

Column labeling scheme, by default it will be Numbers.

Available permissible values are :

{Numbers, Alphabets Upper Case, Alphabets Lower Case, Roman Upper Case, Roman Lower Case}

temperature [Optional] Temperature of the container.

storeSpecimensEnabled Allow to store specimens in container.

allowedSpecimenClasses [Optional] Allowed specimen classes to store in container

allowedSpecimenTypes [Optional] Allowed specimen types to store in container

allowedCollectionProtocols [Optional] Title of collection protocols to restrict specific protocol for storage

createdBy User info object containing loginName and domainName of user, who had been created the container.

http[s]:<host>:<port>/openspecimen/rest/ng/storage-containers/{id}

Use this URL to update storage container in openSpecimen 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>/openspecimen/rest/ng/storage-containers/1

Method PUT

Request application/json

json

Code Block

{
"name":"Ark -80 F1",
"barcode":"ARKF1",
"typeName":"Freezer",
"activityStatus":"Active",
"siteName":"Arkansas Repository",
"storageLocation":{},
"createdBy" {
              "id":1,
              "loginName":"admin@admin.com",
              "domain":"openspecimen",
              "emailAddress":"openspecimendemo@gmail.com"
            },
"noOfColumns":1,
"noOfRows":4,
"storeSpecimensEnabled":true,
"childContainers":null,
"temperature":-80,
"columnLabelingScheme":"Numbers","rowLabelingScheme":"Numbers",
"comments":null,
"allowedSpecimenClasses":["Fluid"],
"allowedSpecimenTypes":["DNA"],
"allowedCollectionProtocols":["LCP"]
}

Response

Code Block

{
"id":1,
"name":"Ark -80 F1",
"barcode":"ARKF1",
"typeName":"Freezer",
"activityStatus":"Active",
"siteName":"Arkansas Repository",
"storageLocation":{},
"createdBy" {
   "id":1,
   "firstName":"Admin",
   "lastName":"Admin",
   "loginName":"admin@admin.com",
   "domain":"openspecimen",
   "emailAddress":"openspecimendemo@gmail.com",
   "instituteName":null,
   "admin":true,
   "manageForms":false,
   "cpCount":0,
   "creationDate":null
},
"noOfColumns":1,
"noOfRows":4,
"freePositions":0,
"storeSpecimensEnabled":false,
"childContainers":null,
"temperature":-80,
"columnLabelingScheme":"Numbers",
"rowLabelingScheme":"Numbers",
"comments":null,
"allowedSpecimenClasses":["Fluid"],
"calcAllowedSpecimenClasses":["Fluid"],
"allowedSpecimenTypes":["DNA"],
"calcAllowedSpecimenTypes":["DNA"],
"allowedCollectionProtocols":["LCP"],
"calcAllowedCollectionProtocols":["LCP"],
"occupiedPositions":[1,2,3,4]
}

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

Versions Compared

Old Version 1

New Version Current

Key