openspecimen/rest/ng/container-types

Use this resource to create container type in the OpenSpecimen 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:

Parameter	Detail
name	Container type name. Should be unique
nameFormat	Container Naming format. Please refer https://openspecimen.atlassian.net/wiki/x/a4CB for available tokens.
noOfRows	Number of rows
noOfColumns	Number of columns
rowLabelingScheme [Optional]	Row labeling scheme, by default it will be N`umbers`. 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 N`umbers`. Available permissible values are : {Numbers, Alphabets Upper Case, Alphabets Lower Case, Roman Upper Case, Roman Lower Case}
temperature [Optional]	Temperature of container
storeSpecimenEnabled [Optional]	Can store specimens in container of this type. Either true or false. By default its false.
canHold [Optional]	Can hold container type detail. Ex: 'Freezer' can hold 'Rack', 'Rack' can hold 'Box'

http[s]:<host>:<port>/openspecimen/rest/ng/container-types

Use this url to create container type.

Below is the example of the create container type:

URL	`http://<host>:<port>/`openspecimen/rest/ng/container-types
Method	POST
Request	application/json
json	{ "name":"Freezer", "nameFormat":"F-%SITE_UID%", "noOfRows":"5", "noOfColumns":"5", "rowLabelingScheme":"Numbers", "columnLabelingScheme":"Numbers", "temperature":"-80", "storeSpecimenEnabled":false, "canHold":{ "id":2, "name":"Rack" } }
Response	{ "id": 13, "name": "Freezer", "nameFormat": "F-%SITE_UID%", "noOfColumns": 5, "noOfRows": 5, "columnLabelingScheme": "Numbers", "rowLabelingScheme": "Numbers", "temperature": -80, "storeSpecimenEnabled": false, "activityStatus": "Active", "canHold": { "id": 2, "name": "Rack", "nameFormat": "%PCONT_NAME%-RK-%PCONT_UID%", "noOfColumns": 10, "noOfRows": 10, "columnLabelingScheme": "Numbers", "rowLabelingScheme": "Numbers", "temperature": -90, "storeSpecimenEnabled": true, "activityStatus": "Active" } }

Error Cases :

code	Applies to	Status Message
200	All resources	Container type has been created successfully
400	All requests	Invalid parameters.
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations

Browser not supported