Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

List of mandatory fields:

  1. cprId
  2. cpeIdeventId
  3. ppid
  4. eventLabel
  5. eventPoint
  6. cpTitle
  7. cpShortTitle
  8. name
  9. clinicalDiagnosis
  10. clinicalStatus
  11. activityStatus
  12. collectionSiteNamesite
  13. collectionStatusstatus
  14. barcodecomments
  15. comment
  16. surgicalPathologyNumber
  17. collectorNamesprName
  18. collectionTimestamp
  19. collectionComments
  20. collectionProcedure
  21. collectionContainer
  22. receiverName
  23. receivedTimestamp
  24. receivedComments
  25. receivedQuality
  26. visitDate
  27. code
URLcatissuecore/rest/ng/specimen-collection-groupsvisits
Request typeapplication/json
MethodPOST
json

{
   "cprId":5,
   "

cpeId

eventId":2,

   "cpShortTitle":"CNS"
   "name":"skinCancerStudy_1_11",
   "clinicalDiagnosis":"Not Specified",
   "clinicalStatus":"Not Specified",
   "activityStatus":"Active",
   "

collectionSiteName

site":"ATCC",
   "collectionStatus":"Complete", 
   

"barcode

"

:"barcode1",
   "

surgicalPathologyNumber":"path123"

,
   "collectorName":"tester@site.com",
   "collectionTimestamp":"2014-04-21",
   "collectionComments":"comments",
   "collectionProcedure":"Lavage",
   "collectionContainer":"CPT",
   "receiverName":"tester@site.com",
   "receivedTimestamp":"2014-04-21",
   "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":"2014-04-21",
   "collectionComments":"comments",
   "collectionProcedure":"Lavage",
   "collectionContainer":"CPT",
   "receiverName":"tester@site.com",
   "receivedTimestamp":"2014-04-21",
   "receivedQuality":"Clotted"
}

 

Error Cases :

code
Applies to
Status Message
200All resourcesSpecimen Collection group has been created successfully
400All requestsInvalid parameters, e.g  duplicate name, duplicate barcode, invalid Site Name etc
401All requestsAuthorization failed, User doesn’t have Authority to create specimen collection group for the given collection protocol
500All requestsInternal server error, Encountered server error while performing operations