...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
caTissue REST API
The purpose of this document is to explain the caTissue REST API to be used for communicating with other applications. caTissue expose REST API for performing add/update/search operation on Specimen, SpecimenCollectionGroup and creating aliquots/derivatives for the parent specimen.
Common Characteristics of REST Resources
The following characteristics apply to all caTissue API resources:
...
On this page, when a portion of a URL, path, or parameter value is shown in italics, this indicates that you should replace the italicized value with a particular value appropriate to your request.
List of resources which are accessible through REST
- caTissue REST API's are signed requests, accessible to all the users who has access to caTissue application. To access the REST API's user need to pass their caTissue credentials by setting them in request Authorization header. The username/password should be encoded in base 64 encoding scheme.
Specimen Resource
catissuecore/rest/specimens
...
Response
| Status | Response |
|---|---|
| 201 | application/json {"id":1,"label":"testLabel","className":"Tissue","type":"Not Specified","barcode":"12345","createdDate":"Jul 31, 2013 11:16:14 AM","availableQuantity":2.0,"activityStatus":"Active","isToPrintLabel":false} |
| 403 | {"error":"User is not authorized to create the specimens"} |
| 500 | {"error" : "Something went wrong. please try again later"} |
...
Response
| Status | Response |
|---|---|
| 201 | application/json {"id":1,"label":"testLabel","className":"Tissue","type":"Not Specified","barcode":"12345","createdDate":"Jul 31, 2013 11:16:14 AM","availableQuantity":2.0,"activityStatus":"Closed","isToPrintLabel":false} |
| 403 | {"error":"User is not authorized to create the specimens"} |
| 500 | {"error" : "Something went wrong. please try again later"} |
...
Response
| Status | Response |
|---|---|
| 200 | application/json {"id":1,"label":"testLabel","className":"Tissue","type":"Not Specified","barcode":"12345","createdDate":"Jul 31, 2013 11:16:14 AM","availableQuantity":2.0,"activityStatus":"Active","isToPrintLabel":false} |
| 404 | {"error" : "No Specimen found with given label/barcode <label/barcode>"} |
| 500 | {"error" : "Something went wrong. please try again later"} |
...
Response
| Status | Response |
|---|---|
| 200 | application/json |
| 403 | {"error":"User doesn't have specimen processing privileges"} |
| 404 | {"error":"Parent with label/barcode <label/barcode> doesn't exist |
| 500 | {"error" : "Something went wrong. please try again later"} |
...
Response
| Status | Response |
|---|---|
| 200 | application/json |
| 403 | {"error":"User doesn't have specimen processing privileges"} |
| 404 | {"error" : "Parent with given label/barcode <label/barcode> doesn't exist"} |
| 500 | {"error" : "Something went wrong. please try again later"} |
Specimen Collection Group Resource
catissuecore/rest/groups
Creates the specimen collection group.
...
Response
| Status | Response |
|---|---|
| 200 | application/json |
| 403 | {"error":"User doesn't have privileges to create Specimen collection group"} |
| 500 | {"error" : "Something went wrong. please try again later"} |
...
Response
| Status | Response |
|---|---|
| 200 | application/json |
| 403 | {"error":"User doesn't have privileges on this Specimen collection group"} |
| 500 | {"error" : "Something went wrong. please try again later"} |
...
Response
| Status | Response |
|---|---|
| 200 | application/json |
| 404 | {"error" : "No group found with title '<title-name>'"} |
| 500 | {"error" : "Something went wrong. please try again later"} |
...