Versions Compared

Key

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

http[data-colorid=a9vnmp1f4c]{color:#4488aa} html[data-color-mode=dark] [data-colorid=a9vnmp1f4c]{color:#5599bb}[data-colorid=gb5vic2tfg]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=gb5vic2tfg]{color:#ffac31}[data-colorid=k2txplwz25]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=k2txplwz25]{color:#ffac31}[data-colorid=qdzdj6tovg]{color:#4488aa} html[data-color-mode=dark] [data-colorid=qdzdj6tovg]{color:#5599bb}[data-colorid=g506mt7mz8]{color:#4488aa} html[data-color-mode=dark] [data-colorid=g506mt7mz8]{color:#5599bb}[data-colorid=kci0oi2gv3]{color:#4488aa} html[data-color-mode=dark] [data-colorid=kci0oi2gv3]{color:#5599bb}[data-colorid=ewclm2tssl]{color:#4488aa} html[data-color-mode=dark] [data-colorid=ewclm2tssl]{color:#5599bb}[data-colorid=rl0hyt7woi]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=rl0hyt7woi]{color:#ffac31}[data-colorid=y1hs6wtaok]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=y1hs6wtaok]{color:#ffac31}[data-colorid=t405wkhbul]{color:#4488aa} html[data-color-mode=dark] [data-colorid=t405wkhbul]{color:#5599bb}[data-colorid=my0526ynyx]{color:#4488aa} html[data-color-mode=dark] [data-colorid=my0526ynyx]{color:#5599bb}[data-colorid=wlm43f7k4a]{color:#4488aa} html[data-color-mode=dark] [data-colorid=wlm43f7k4a]{color:#5599bb}[data-colorid=eqevda8r3u]{color:#777777} html[data-color-mode=dark] [data-colorid=eqevda8r3u]{color:#888888}[data-colorid=noumpnik9b]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=noumpnik9b]{color:#ffac31}[data-colorid=vtm2cxqjsi]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=vtm2cxqjsi]{color:#ffac31}[data-colorid=aplcgkl3lj]{color:#4488aa} html[data-color-mode=dark] [data-colorid=aplcgkl3lj]{color:#5599bb}[data-colorid=vqvld0ejd4]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=vqvld0ejd4]{color:#ffac31}[data-colorid=j1bhsd0gon]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=j1bhsd0gon]{color:#ffac31}[data-colorid=funiig834t]{color:#4488aa} html[data-color-mode=dark] [data-colorid=funiig834t]{color:#5599bb}[data-colorid=aqrd135yjq]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=aqrd135yjq]{color:#ffac31}[data-colorid=sn2fymt0g0]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=sn2fymt0g0]{color:#ffac31}[data-colorid=hfjhjh4kqk]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=hfjhjh4kqk]{color:#ffac31}[data-colorid=ywyt5c8hnq]{color:#4488aa} html[data-color-mode=dark] [data-colorid=ywyt5c8hnq]{color:#5599bb}[data-colorid=a7yc204otm]{color:#4488aa} html[data-color-mode=dark] [data-colorid=a7yc204otm]{color:#5599bb}catissuecores]:<host>:<port>/openspecimen/rest/ng/sites

Use this resource to create new Site site in the caTissue applicationopenSpecimen application. Use HTTP POST method to call this API by passing the below details in JSONformatJSON format.

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

Activity status of the site, permissible values are
Parameter
Details
namename Name of the physical location.
instituteNameName of the institute which site is belongs to
coordinatorCollectioncoordinatorsactivityStatus

Collection of user login namesobject. User Info contains Login Name through which user can login to catissue application,

should be unique in authentication domains

typeType of site.This attribute is should not be blank.

Name and Domain Name

type

Function of the site. It could be collection, storing, experimentation or it could be unspecified

{ collection site,repository,laboratory,not specified }

activityStatus

Defines the status of a site record

{active, closed, pending, disabled}

streetName of street to which site belongs.
cityCity of which the site belongs.
state [optional]State of which the site belongs, By default it will be blank.
countryCountry of which the site belongs.
zipCodeZip Code of location which the site belongs.
faxNumber [optional]Fax number of the site, By default it will be blank.
phoneNumber [optional]Phone number of the site, By default it will be blank.
addressAddress of the site

 

http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/sites

Use this URL to add site in caTissue openSpecimen application.

 

Result:

The response of this request will contains the details of the created site.

...

 

{

name"Pune101"
coordinatorCollection[2]
siteId48
type"Collection Site"
activityStatus"Active"
street"SB Road"
city"Pune"
state"MH"
country"India"
zipCode"412312"
faxNumber"123321"
phoneNumber"213434324"
URLhttp://<host>:<port>/catissuecoreopenspecimen/rest/ng/sites
MethodPOST
Requestapplication/json
json
Code Block
language
{

"name" : "Pune101",

"coordinatorCollection" : ["super@super.com","admin@admin.com"],

"type" : "Collection Site",

"activityStatus" : "Active",

"street" : "SB Road",

"city" : "Pune",

"state" : "MH",

"country" : "India" ,

"zipCode" : "412312",

"faxNumber" : "123321",

"phoneNumber" : "213434324"

}

Response

js
themeEclipse
linenumberstrue
{
    "name": "Arkansas Hospital",
    "instituteName": "A1 - For Demo Users",
    "type": "Collection Site",
    "activityStatus": "Active",
    "coordinators":
    [
        {
            "loginName": "aalfortish",
            "domain": "openspecimen"
        },
        {
            "loginName": "vinod",
            "domain": "openspecimen"
        }
    ],
    "address": "Arkansas"
}

Response

Code Block
languagejs
themeEclipse
linenumberstrue
{
    "id": 4,
    "name": "Arkansas Hospital",
    "instituteName": "A1 - For Demo Users",
    "type": "Collection Site",
    "activityStatus": "Active",
    "cpCount": 0,
    "coordinators":
    [
        {
            "id": 107,
            "firstName": "Alexandra",
            "lastName": "Alfortish",
            "loginName": "aalfortish",
            "domain": "openspecimen",
            "emailAddress": "aalfortish@lcrc.info",
            "admin": false,
            "cpCount": 0,
            "creationDate": 1438021800000
        },
        {
            "id": 14,
            "firstName": "Vinod",
            "lastName": "Gaikwad",
            "loginName": "vinod",
            "domain": "openspecimen",
            "emailAddress": "vinod.gaikwad@domain.com",
            "admin": false,
            "cpCount": 0,
            "creationDate": null
        }
    ],
    "address": "Arkansas",
}

 

Error Cases :

code
Applies to
Status Message
200All resourcesSite has been created successfully
400All requestsInvalid parameters, e.g  duplicate Site Name, blank Site Name, blank Site Type etc
401All requestsAuthorization failed, User doesn’t user doesn't have Authority
500All requestsInternal server error, Encountered server error while performing operations