Updating a Specimen List
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Updating a Specimen List

Summary

This page contains documentation for updating 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:

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:

id

 Identifier of the specimen.

specimenListId

Identifier of the specimen list.

 

Result

The response of this request will contain the details of the updated specimen-list.

URL

http://<host>:<port>/catissuecore/rest/ng/specimen-lists/{specimenListId}

Method

PUT

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 updated successfully.

400

All requests

Invalid parameters, e.g Invalid User-ids, Invalid Specimen-ids.

401

All requests

Authorization failed, User doesn’t have Authority.

500

All requests

Internal server error, Encountered server error while performing operations.

Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com