Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Use this resource to get storage containers . This API returns all the institutes 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.

...

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

...

URLhttp://<host>:<port>/openspecimen/rest/ng/storage-containers
MethodGET
Requestapplication/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":"Activeactive",

"createdBy" : {

              "loginName" : "admin@admin.com",

               "domainName" :"catissue"

},

"siteName":"My Site",

"parentContainerName": "Freezerfreezer"

}]

 

 

Error Cases :

code
Applies to
Status Message
200All resourcesStorage containers got successfully
401All requestsAuthorization failed, User user doesn’t have Authorityauthority
500All requestsInternal server error, Encountered encountered server error while performing operations