Creating a Specimen List

Summary

This page contains documentation for creating a specimen list.

Request Details

Parameter		Details
label	A display name for Specimen-list.
sharedWith [optional]	Collection of Users with whom the list is shared with. This member is optional. This has the below attributes:
sharedWith [optional]	id	User id of the person with whom the list is shared with.
specimens [optional]	Collection of specimens which belong to the given list. A Specimen-list can have one or more specimens in it. This has the below attributes:
specimens [optional]	id	Identifier of the specimen.

Endpoint and Payload details

The response of this event will contain the details of the newly created specimen-list. The response will also contain auto-generated id (identifier) for the specimen list. This id should be used to perform other specimen list actions like updating a specimen list, deleting a specimen list.

URL	http://<host>:<port>/catissuecore/rest/ng/specimen-lists
Method	POST
Content-Type	application/json
Request	{ "label": "Brain Cancer CP - C123 - S1", "sharedWith": [ { "id": 2 }, { "id": 3 } ], "specimens": [ { "id": 12 }, { "id": 13 } ] }
Response	{ "id": 49, "label": "Brain Cancer CP - C123 - List1", "owner": { "id": 1, "firstName": "current-user", "lastName": "current-user", "loginName": "currentuser@example.com" }, "sharedWith": [ { "id": 3, "firstName": "tech", "lastName": "tech", "loginName": "tech@tech.com" }, { "id": 2, "firstName": "super", "lastName": "super", "loginName": "super@super.com" } ], "specimens": [ { "id": 12, "label": "Frozen Specimen - SP12314" }, { "id": 13, "label": "Frozen Specimen - SP12315" } ] }

Error Cases

code	Applies to	Status Message
200	All resources	Specimen-list has been created successfully.
400	All requests	Invalid parameters, e.g Invalid User-ids, Invalid Specimen-ids, Null or empty label.
401	All requests	Authorization failed, User doesn’t have Authority.
500	All requests	Internal server error, Encountered server error while performing operations.