This API is available for creating Specimen Collection Group.
List of mandatory fields:
- cprId
- cpeId
- name
- clinicalDiagnosis
- clinicalStatus
- activityStatus
- collectionSiteName
- collectionStatus
- barcode
- comment
- surgicalPathologyNumber
- collectorName
- collectionTimestamp
- collectionComments
- collectionProcedure
- collectionContainer
- receiverName
- receivedTimestamp
- receivedComments
- receivedQuality
| URL | catissuecore/rest/ng/specimen-collection-groups |
| Request type | application/json |
| Method | POST |
| json | { "cprId":5, "cpeId":2, "name":"skinCancerStudy_1_11", "clinicalDiagnosis":"Not Specified", "clinicalStatus":"Not Specified", "activityStatus":"Active", "collectionSiteName":"ATCC", "collectionStatus":"Complete", "barcode":"barcode1", "surgicalPathologyNumber":"path123", "collectorName":"tester@site.com", "collectionTimestamp":"Jul 1, 2014 8:11:36 PM", "collectionComments":"comments", "collectionProcedure":"Lavage", "collectionContainer":"CPT", "receiverName":"tester@site.com", "receivedTimestamp":"MAY 1, 2014 8:11:36 PM", "receivedQuality":"Clotted" } |
Response | { "id":1, "cprId":5, "cpeId":2, "name":"skinCancerStudy_1_11", "clinicalDiagnosis":"Not Specified", "clinicalStatus":"Not Specified", "activityStatus":"Active", "collectionSiteName":"ATCC", "collectionStatus":"Complete", "barcode":"barcode1", "surgicalPathologyNumber":"path123", "collectorName":"tester@site.com", "collectionTimestamp":"Jul 1, 2014 8:11:36 PM", "collectionComments":"comments", "collectionProcedure":"Lavage", "collectionContainer":"CPT", "receiverName":"tester@site.com", "receivedTimestamp":"MAY 1, 2014 8:11:36 PM", "receivedQuality":"Clotted" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Specimen has been created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate label, duplicate barcode, invalid class Name etc |
| 401 | All requests | Authorization failed, User doesn’t have Authority to create specimen for the given collection protocol |
| 500 | All requests | Internal server error, Encountered server error while performing operations |