Versions Compared

Key

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

openspecimen/rest/ng/institutes/{id}

or

openspecimen/rest/ng/institutes/byname?name={name}

 

Use this resource to get institute . This API returns the institute present in the openSpecimen application of given name and id. 

Below are the attributes which need to be sent in the url :

Parameter
Details
idInstitute id to fetch the institute
nameInstitute name to fetch the institute


http[s]:<host>:<port>/openspecimen/rest/ng/institutes/{id}

or

http[s]:<host>:<port>/openspecimen/rest/ng/institutes/byname?name={name}


Use this URL to get institute by an id in openSpecimen application.

Result:

The response of this request will contains the details of the institute.

Below is the example of the get institute:

URL

http://<host>:<port>/openspecimen/rest/ng/institutes/1

or

http://<host>:<port>/openspecimen/rest/ng/institutes/byname?name=Bocabio

MethodGET
Requestapplication/json

Response

Code Block
languagejs
themeEclipse
linenumberstrue
{
    "id": 1,
    "name": "Bocabio",
    "activityStatus": "Active",
    "departmentsCount": 0,
    "usersCount": 0,
    "departments":
    [
        {
            "id": 47,
            "name": "Tissue Banking"
        }
    ]
}

 

Error Cases :

code
Applies to
Status Message
200All resourcesInstitute got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations