Versions Compared

Key

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

...

List of mandatory fields:

  1. cprId
  2. cpeId
  3. name
  4. clinicalDiagnosis
  5. clinicalStatus
  6. activityStatus
  7. collectionSiteName
  8. collectionStatusbarcode
  9. comment
  10. surgicalPathologyNumber
  11. collectorName
  12. collectionTimestamp
  13. collectionComments
  14. collectionProcedure
  15. collectionContainer
  16. receiverName
  17. receivedTimestamp
  18. receivedComments
  19. receivedQuality
URLcatissuecoreopenspecimen/rest/ng/specimen-collection-groupsvisits/{scg_id}
Request typeapplication/json
MethodPUT
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":"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 updated 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