Get All Storage Containers

openspecimen/rest/ng/storage-containers

or

openspecimen/rest/ng/storage-containers?maxResults={maxResults}

Use this resource to get storage containers . This API returns all the storage containers present in the open specimen application. User can also specify the max results to fetch the desired number of records.

Use HTTP GET method to call this API by passing the below details in JSON format.

The attributes description :

Parameter	Details
maxResults	Maximum number of records to fetch. By default it will be 1000

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

or

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

Use this URL to get storage containers in open specimen application.

Result:

The response of this request will contains the details of the storage containers.

Below is the example of the get storage containers:

URL	`http://<host>:<port>/`openspecimen/rest/ng/storage-containers
Method	GET
Request	application/json
Response	[ { "id" : 1, "name":"Container1", "barcode":"2-edpwesdadas-343", "activityStatus":"Active", "createdBy" : { "loginName" : "admin@admin.com", "domainName" :"catissue" }, "siteName":"My Site", "parentContainerName": "Freezer" }, { "id" : 2, "name":"Container2", "barcode":"2-edpwesdadas-3", "activityStatus":"active", "createdBy" : { "loginName" : "admin@admin.com", "domainName" :"catissue" }, "siteName":"My Site", "parentContainerName": "freezer" }]

Error Cases :

code	Applies to	Status Message
200	All resources	Storage containers got successfully
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations