openspecimen/rest/ng/collection-protocols
...
| URL | http://<host>:<port>/openspecimen/rest/ng/collection-protocols | |||||||||||||||
| Method | POST | |||||||||||||||
| Request | application/json | |||||||||||||||
| json | { "title": "My CpLiverCancer Study", "shortTitle": "LCS", "cpType": "CpMParent", "startDate": "2014-07-23", "endDate" : "2018-07-23", -02-02","activityStatus": "Active", "cpeDetails": [ { "collectionPointLabel":"First Follow-up", "labelFormat":"dsasad", "activityStatus":"Active", "specimenRequirementDetails": [ { "collectionTimestamp":"2014-09-12", "collector": { "loginName":"admin@admin.com", "domainName":"catissue" }, "receiver": { "loginName":"admin@admin.com", "domainName":"catissue" }, "collectionContainer":"Frizeer", "collectionProcedure" : "Needle Aspirate", "receivedQuality":"Acceptable", "labelFormat":null, "lineage" : "New", "specimenRequirementLabel":null, "activityStatus":"Active", "childSpecimenRequirementCollection": [ { "investigator "collectionTimestamp":"2014-09-12", "collector": { "loginName":"admin@admin.com", "domainName":"catissue" }, "cpSiteRolesreceiver": { "loginName":"admin@admin.com", "domainName":"catissue" "siteName" : "My Site", "roleName" : "Scientist" } } | Response | }, "collectionContainer":"Frizeer", "collectionProcedure" : "Not Specified", "receivedQuality":"Acceptable", "labelFormat":null, "lineage" : "Aliquot", "specimenRequirementLabel":null, "activityStatus":"Active", "childSpecimenRequirementCollection":[ ] } ] }, { "collectionTimestamp":"2014-09-12", "collector": { "loginName":"admin@admin.com", "domainName":"catissue" }, "receiver":{ "loginName":"admin@admin.com", "domainName":"catissue" }, "collectionContainer":"Frizeer", "collectionProcedure" : "Needle Aspirate", "receivedQuality":"Acceptable", "labelFormat":Null, "lineage" : "New", "specimenRequirementLabel":null, "activityStatus":"Active", "childSpecimenRequirementCollection": [ { "collectionTimestamp":"2014-09-12", "collector": { "loginName":"admin@admin.com", "domainName":"catissue" }, "receiver": { "loginName":"admin@admin.com", "domainName":"catissue" }, "collectionContainer":"container", "collectionProcedure" : "Needle Aspirate", "receivedQuality":"Acceptable", "labelFormat": | null"ss", " | derivedLabelFormatlineage" : | null"Aliquot", " | aliquotLabelFormatspecimenRequirementLabel":"null, " | ppIdFormatactivityStatus":"Active", | " | cpSiteRoles" : {childSpecimenRequirementCollection":[ ] } ] } ] | "id} ], "coordinators": | 1,[], "investigator": { " | siteNameloginName": " | My Siteadmin@admin.com", " | roleNamedomainName": " | Scientist" }catissue" } } |
Response | { id: 158 title: "LiverCancer Study" shortTitle: "LCS" cpType: "Parent" startDate: 1391299200000 endDate: null activityStatus: "Active" labelFormat: null derivedLabelFormat: null aliquotLabelFormat: null ppIdFormat: null cpeDetails: { id: 1038 collectionPointLabel: "First Follow-up" studyCalendarEventPoint: null labelFormat: null activityStatus: "Active" defaultSiteName: null specimenRequirementDetails: { id: 14295 collectionTimestamp: 1410480000000 collectionComments: null collectionProcedure: "Needle Aspirate" collectionContainer: "Frizeer" receivedQuality: "Acceptable" receivedTimestamp: null receivedComments: null collectionProtocolEvent: null childSpecimenRequirementCollection: { id: 14296 collectionTimestamp: 1410480000000 collectionComments: null collectionProcedure: "Needle Aspirate" collectionContainer: "container" receivedQuality: "Acceptable" receivedTimestamp: null receivedComments: null collectionProtocolEvent: null childSpecimenRequirementCollection: [0] tissueSite: null tissueSide: null pathologicalStatus: null lineage: "Aliquot" initialQuantity: null specimenClass: null specimenType: null labelFormat: null specimenRequirementLabel: null activityStatus: "Active" } tissueSite: null tissueSide: null pathologicalStatus: null lineage: "New" initialQuantity: null specimenClass: null specimenType: null labelFormat: null specimenRequirementLabel: null activityStatus: "Active" }, { id: 14297 collectionTimestamp: 1410480000000 collectionComments: null collectionProcedure: "Needle Aspirate" collectionContainer: "Frizeer" receivedQuality: "Acceptable" receivedTimestamp: null receivedComments: null collectionProtocolEvent: null childSpecimenRequirementCollection: { id: 14298 collectionTimestamp: 1410480000000 collectionComments: null collectionProcedure: "Not Specified" collectionContainer: "Frizeer" receivedQuality: "Acceptable" receivedTimestamp: null receivedComments: null collectionProtocolEvent: null childSpecimenRequirementCollection: [0] tissueSite: null tissueSide: null pathologicalStatus: null lineage: "Aliquot" initialQuantity: null specimenClass: null specimenType: null labelFormat: null specimenRequirementLabel: null activityStatus: "Active" } tissueSite: null tissueSide: null pathologicalStatus: null lineage: "new" initialQuantity: null specimenClass: null specimenType: null labelFormat: null specimenRequirementLabel: null activityStatus: "Active" } } coordinators: [0 ] cpSiteRoles: [0] } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Collection Protocol has been created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate CP title, blank CP title etc |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |