Versions Compared

Version Old Version 4 New Version Current
Changes made by

Darpan Patil (Deactivated)

Vinod Gaikwad (Unlicensed)

Saved on

Key

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

catissuecoreopenspecimen/rest/ng/storage-containers

Use this resource to create new storage container in the caTissue open specimen application. Use HTTP POST 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:

...

ParameterDetails
nameContainer
Name
name. It should be unique in application
barcode
Container BarcodeactivityStatusActivity Status of containertempratureInCentigradeTemperature of storage container

 

[Optional]Container barcode, By default it will be null. It should be unique in application if barcode is provided
typeName [Optional]Container type name.
siteNameSite name in which the container is present
parentContainerDetails[Optional]Details of parent container, having parameters like, name, barcode etc. By default is will be nullspecimenPositionDetails

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

 cpNameCollectionName of collection protocols to restrict specific protocol for storageholdsSpecimenClassCollectionName of specimen classes which container holds.holdsSpecimenTypeCollectionName of specimen types which container holdscapacityDetails

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
storageLocation

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

idIdentifier of the parent container
nameName of the parent container.
positionXColumn position
positionYRow position
noOfRowsNumber of rows in container
noOfColumnsNumber of columns in conatiner
rowLabelingScheme

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

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}

temperatureTemperature of the container.
storeSpecimensEnabledAllow to store specimens in container
allowedSpecimenClassesAllowed specimen classes to store in container
allowedSpecimenTypesAllowed specimen types to store in container
allowedCollectionProtocolsTitle of collection protocols to restrict specific protocol for storage
createdByUser info object containing loginName and domainName of user, who had been created the container.


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

Use this URL to add storage container in caTissue open specimen application.

Result:

The response of this request will contains the details of the created storage container.

Below is the example of the create storage container:

 

URLhttp://<host>:<port>/
catissuecore
openspecimen/rest/ng/
roles
storage-containers
MethodPOST
Requestapplication/json
json
Code Block
{

"name":"
Container1
Ark -80 F1",

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

"activityStatus":"Active",

"tempratureInCentigrade":22.22,

"siteName":"My Site",

"parentContainerDetails":{

        "name"

"typeName":"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":{

            "oneDimensionCapacity":10,

            "twoDimensionCapacity":10

        }

    },

"specimenPositionDetails":[

    {

    "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":{"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"

    }

],

"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

     }

}


"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
200All resourcesStorage
Container
container has been created successfully
400All requestsInvalid parameters, e.g  duplicate
Container Name
container name, blank
Container Name
container name etc
401All requestsAuthorization failed,
User
user doesn’t have
Authority
authority
500All requestsInternal server error,
Encountered
encountered server error while performing operations