Versions Compared

Key

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

...

URLhttp://<host>:<port>/openspecimen/rest/ng/collection-protocols
MethodPOST
Requestapplication/json
json

{
"id": 2,
"shortTitle": "A Planned Clinical Study FD",
"title": "Planned Clinical Study",
"code": null,
"principalInvestigator":
{
"loginName": "admin@admin.com",
"domain": "openspecimen"
},
"startDate": 1427653800000,
"endDate": 1454178600000,
"participantCount": null,
"specimenCount": null,
"ppidFmt": "DWP%05d",
"manualPpidEnabled": false,
"coordinators":
[
],
"cpSites":
[
{

"siteName": "Arkansas Repository",
"code": "CS_123"
},
{

"siteName": "Arkansas Hospital",
"code": "CS_34"
}
],
"consentsWaived": false,
"irbId": "65465",
"anticipatedParticipantsCount": null,
"descriptionUrl": null,
"specimenLabelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%",
"derivativeLabelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%",
"aliquotLabelFmt": "%PSPEC_LABEL%.%PSPEC_UID%",
"visitNameFmt": null,
"manualVisitNameEnabled": false,
"manualSpecLabelEnabled": true,
"aliquotsInSameContainer": null,
"activityStatus": "Active"
}

Response

  • {

  •    
  • "id": 2,

       

    "shortTitle": "A Planned Clinical Study FD",

  •    
  • "title": "Planned Clinical Study",

       

    "code": null,

  •    
  • "principalInvestigator":

       

    {

  •        
  • "id": 1,

           

    "firstName": "Admin",

  •        
  • "lastName": "Admin",

           

    "loginName": "

    admin@admin

    admin@admin.com",

  •        
  • "domain": "openspecimen",

           

    "emailAddress": "

    openspecimendemo@gmail

    openspecimendemo@gmail.com",

  •        
  • "admin": true,

           

    "cpCount": 0,

  •        
  • "creationDate": null

  •  

  •    

    },

  •    
  • "startDate": 1427653800000,

       

    "endDate": 1454178600000,

  •    
  • "participantCount": null,

       

    "specimenCount": null,

  •    
  • "ppidFmt": "DWP%05d",

       

    "manualPpidEnabled": false,

  •    
  • "coordinators":

       

    [

  •    
  • ],

       

    "cpSites":

  •    
  • [

           

    {

  •            
  • "id": 2,

               

    "siteName": "Arkansas Repository",

  •            
  • "code": "CS_123"

  •  

  •        

    },

  •        
  • {

               

    "id": 25,

  •            
  • "siteName": "Arkansas Hospital",

               

    "code": "CS_34"

     


  •        
  • }

       

    ],

  •    
  • "consentsWaived": false,

       

    "irbId": "65465",

  •    
  • "anticipatedParticipantsCount": null,

       

    "descriptionUrl": null,

  •    
  • "specimenLabelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%",

       

    "derivativeLabelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%",

  •    
  • "aliquotLabelFmt": "%PSPEC_LABEL%.%PSPEC_UID%",

       

    "visitNameFmt": null,

  •    
  • "manualVisitNameEnabled": false,

       

    "manualSpecLabelEnabled": true,

  •    
  • "aliquotsInSameContainer": null,

       

    "activityStatus": "Active",

  •    
  • "consents": null,

       

    "events": null

     

    }

 Error Cases :

code
Applies to
Status Message
200All resourcesCollection Protocol has been created successfully
400All requestsInvalid parameters, e.g  duplicate CP title, blank CP title etc
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations