Versions Compared

Key

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

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


Use this resource to get storage container by id . This API returns storage container present in the open specimen application.

 

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

The attributes description :

Parameter
Details
containerIdStorage container id to fetch details.


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


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:

URLhttp://<host>:<port>/openspecimen/rest/ng/storage-containers/1
MethodGET
Requestapplication/json

Response

{

"id" : 1,

"name":"Container1",

"barcode":"2-edpwesdadas-343",

"activityStatus":"ACTIVE",

"createdBy" : {

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

               "domainName" :"catissue"

},

"tempratureInCentigrade":22.22,

"siteName":"My Site",

"parentContainerName": "Freezer",

"holdsCPTitles":["Cp1","my CP"],

"holdsSpecimenTypes" : ["blood","tissue"],

"comments":"Blah blah blah",

"oneDimensionCapacity":10,

 "twoDimensionCapacity":10,

"oneDimentionalLabellingScheme ": "Numbers",

"twoDimentionalLabellingScheme ": "Numbers"

}

 

Error Cases :

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