Versions Compared

Version Old Version 1 New Version 2
Changes made by

Vinod Gaikwad (Unlicensed)

Vinod Gaikwad (Unlicensed)

Saved on

Key

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

openspecimen/rest/ng/container-types

...

Below are the attributes which need to be sent in the request body:

ParameterDetail
nameContainer type name. Should be unique
nameFormatContainer Naming format
noOfRowsNumber of rows
noOfColumnsNumber of columns
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 container
storeSpecimenEnabledCan store specimens in container of this type. Either true or false
canHoldCan hold container type detail. Ex: 'Freezer' can hold 'Rack', 'Rack' can hold 'Box'

 

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

...

URLhttp://<host>:<port>/openspecimen/rest/ng/container-types
MethodPOST
Requestapplication/json
json
Code Block
languagejs
themeEclipse
linenumberstrue
{
  "name":"Freezer",
  "nameFormat":"F-%SITE_UID%",
  "noOfRows":"5",
  "noOfColumns":"5",
  "rowLabelingScheme":"Numbers",
  "columnLabelingScheme":"Numbers",
  "temperature":"-80",
  "storeSpecimenEnabled":false,
  "canHold":{
    "id":2,
    "name":"Rack"
   }
}

Response

Code Block
languagejs
themeEclipse
linenumberstrue
{
  "id": 13,
  "name": "Test1",
  "nameFormat": "T-%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
200All resourcesCollection Protocol Event has been created successfully
400All requestsInvalid parameters, e.g  duplicate event label, blank event label etc
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations

...