Versions Compared

Key

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

http[data-colorid=c3kxoox3si]{color:#4488aa} html[data-color-mode=dark] [data-colorid=c3kxoox3si]{color:#5599bb}[data-colorid=tgbkae3stc]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=tgbkae3stc]{color:#ffac31}[data-colorid=mwuyloxdx9]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=mwuyloxdx9]{color:#ffac31}[data-colorid=t722pu5u6j]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=t722pu5u6j]{color:#ffac31}[data-colorid=aljbu2at96]{color:#4488aa} html[data-color-mode=dark] [data-colorid=aljbu2at96]{color:#5599bb}[data-colorid=xorljcbh8e]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=xorljcbh8e]{color:#ffac31}[data-colorid=q6osodgtdj]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=q6osodgtdj]{color:#ffac31}[data-colorid=uey6nd7tti]{color:#4488aa} html[data-color-mode=dark] [data-colorid=uey6nd7tti]{color:#5599bb}[data-colorid=a0jp2xop11]{color:#770088} html[data-color-mode=dark] [data-colorid=a0jp2xop11]{color:#ee77ff}[data-colorid=dzuprblt28]{color:#4488aa} html[data-color-mode=dark] [data-colorid=dzuprblt28]{color:#5599bb}[data-colorid=jrupontimp]{color:#4488aa} html[data-color-mode=dark] [data-colorid=jrupontimp]{color:#5599bb}[data-colorid=fy6ozk13pb]{color:#4488aa} html[data-color-mode=dark] [data-colorid=fy6ozk13pb]{color:#5599bb}[data-colorid=zo7w7xr02b]{color:#4488aa} html[data-color-mode=dark] [data-colorid=zo7w7xr02b]{color:#5599bb}[data-colorid=kl9h7cllm6]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=kl9h7cllm6]{color:#ffac31}[data-colorid=g8inkurydr]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=g8inkurydr]{color:#ffac31}[data-colorid=ddqhwmyx4c]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=ddqhwmyx4c]{color:#ffac31}[data-colorid=briefdyel3]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=briefdyel3]{color:#ffac31}[data-colorid=u3sccc7z1o]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=u3sccc7z1o]{color:#ffac31}[data-colorid=rq2f5kdwge]{color:#4488aa} html[data-color-mode=dark] [data-colorid=rq2f5kdwge]{color:#5599bb}[data-colorid=i64lfqifzr]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=i64lfqifzr]{color:#ffac31}[data-colorid=l1kvazt68h]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=l1kvazt68h]{color:#ffac31}[data-colorid=vx862waory]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=vx862waory]{color:#ffac31}[data-colorid=o39d22v2qd]{color:#4488aa} html[data-color-mode=dark] [data-colorid=o39d22v2qd]{color:#5599bb}[data-colorid=vpkfdgotud]{color:#ce7b00} html[data-color-mode=dark] [data-colorid=vpkfdgotud]{color:#ffac31}[data-colorid=zn0khmtc1k]{color:#4488aa} html[data-color-mode=dark] [data-colorid=zn0khmtc1k]{color:#5599bb}[data-colorid=ddifdtdlne]{color:#4488aa} html[data-color-mode=dark] [data-colorid=ddifdtdlne]{color:#5599bb}[data-colorid=otum1az2au]{color:#4488aa} html[data-color-mode=dark] [data-colorid=otum1az2au]{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:

Parameter
Details
nameName of the physical location.coordinatorCollection
instituteNameName of the institute which site is belongs to
coordinators

Collection of user info object. UserInfo User Info contains Login Name and Domain Name

type

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

{ Collection Sitecollection site,Repositoryrepository,Laboratorylaboratory,Not Specified not specified }

activityStatus

Defines the status of a Site site record

{active, closed, pending, disabled}

streetName of street to which the site belongs.
cityName of city to which the site belongs.
state [optional]Name of the state to which the site belongs 
countryName of the country to which the site belongs
zipCodeZip Code of location
faxNumber [optional]Fax number of the site
phoneNumber [optional]Phone number of the site

 

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"DD1"
coordinatorCollection
[{ 
      loginName"admin@admin.com"
domainName"catissue"
}]
id6
type"sitesType"
activityStatus"Active"
emailAddressnull
street"SB Road"
city"Pune412312"
state"MH"
country"India"
zipCode"412312"
faxNumber"123321"
phoneNumber"213434324"
URLhttp://<host>:<port>/catissuecoreopenspecimen/rest/ng/sites
MethodPOST
Requestapplication/json
json
Code Block
languagejs
themeEclipse
{
linenumberstrue
{
    "name":
"Pune",

"coordinatorCollection" : [ { "loginName" : "admin@admin.com", "domainName" :"catissue"}],

"type" : "Collection Site",

"activityStatus" : "Active",

"street" : "SB Road",

"city" : "Pune",

"state" : "Maharashtra",

"country" : "India" ,

"zipCode" : "412312",

"faxNumber" : "123321",

"phoneNumber" : "213434324"

}

Response

 "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 user doesn't have Authority
500All requestsInternal server error, Encountered server error while performing operations