Page Comparison

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

Use this resource to create site 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	Details
name	Name of the physical location.
instituteName	Name of the institute which site is belongs to
coordinators	Collection of user object. 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 site,repository,laboratory,not specified }
activityStatus	Defines the status of a site record {active, closed, pending, disabled}
address	Address of the site

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

Use this URL to add site in openSpecimen application.

Result:

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

Below is the example of the create site:

URL http://<host>:<port>/openspecimen/rest/ng/sites

Method POST

Request application/json

json

Code Block

language	js
theme	Eclipse
linenumbers	true

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

language	js
theme	Eclipse
linenumbers	true

{
    "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
200	All resources	Site has been created successfully
400	All requests	Invalid parameters, e.g duplicate Site Name, blank Site Name, blank Site Type etc
401	All requests	Authorization failed, user doesn't have Authority
500	All requests	Internal server error, Encountered server error while performing operations

Versions Compared

Old Version 1

New Version Current

Key