Versions Compared

Key

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

This API is available to register participant to Collection Protocol.

URLcatissuecore/rest/ng/specimens
Requestapplication/json
MethodPOST
json

{ "activityStatus" : "Active",

  "barcode" : "245095132",

  "biohazardDetails" : [  ],

  "collectionStatus" : "Collected",

  "comment" : "creating an adhoc specimen.",

  "createdOn" : "May 1, 2014 11:21:45 AM",

  "externalIdentifierDetails" : [  ],

  "initialQuantity" : 2.0,

  "label" : "sample_123",

  "lineage" : "New",

  "pathologicalStatus" : "Metastatic",

  "scgId" : 1,

  "specimenClass" : "Fluid",

  "specimenType" : "Feces",

  "tissueSide" : "Left",

  "tissueSite" : "Nasal cavity"

}

Response

 

{ "activityStatus" : "Active",

  "barcode" : "",

  "biohazardDetails" : [  ],

  "collectionStatus" : "Collected",

  "comment" : "creating an adhoc specimen.",

  "createdOn" : "May 1, 2014 11:21:45 AM",

  "externalIdentifierDetails" : [  ],

  "id" : 2,

  "initialQuantity" : 2.0,

  "label" : "",

  "lineage" : "New",

  "pathologicalStatus" : "Metastatic",

  "scgId" : 1,

  "specimenClass" : "Fluid",

  "specimenType" : "Feces",

  "tissueSide" : "Left",

  "tissueSite" : "Nasal cavity"

}

 

Error Cases :

code
Applies to
Status Message
200All resourcesParticipant registered successfully
400All requestsInvalid parameters, e.g  duplicate PPID, duplicate barcode etc
401All requestsAuthorization failed, User doesn’t have privileges to register Participants
500All requestsInternal server error, Encountered server error while performing operations