Get Specimen Event Forms

openspecimen/rest/ng/forms?formType=specimenEvent

Use this resource to get the list of all the specimen event forms available in the openSpecimen application.

Use HTTP GET method to call this API.

http[s]:<host>:<port>/openspecimen/rest/ng/forms?formType=specimenEvent

Result:

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

Below is the example of the get specimens:

URL	http://<host>:<port>/openspecimen/rest/ng/forms?formType=specimenEvent
Method	GET
Request	application/json
Response	`[{"formId":6,"name":"SpecimenCellReviewEvent","caption":"Cell Review Event",` `"createdBy":{"id":1,"firstName":"Admin","lastName":"Admin","loginName":null},` `"creationTime":1415173522000,"modificationTime":1415173522000,"cpCount":-1,"sysForm":false}]`

Response details:

Attribute	Description
formId	System Identifier of the form. This is referred as form context Id
name	System name of the form.
caption	Name which will be displayed on UI
createdBy	Owner of the form
creationTime(in miliseconds)	Time when the form is created
modificationTime(in miliseconds)	Time when the form is last modified
cpCount	The count of CP's with which this form is associated. -1 specified that this form is available for all CP's

Error Cases :

code	Applies to	Status Message
200	All resources	Specimen events got successfully
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations