Versions Compared

Key

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

...

URLopenspecimen/rest/ng/users/1
MethodPUT
Requestapplication/json
json

{

Code Block
languagejs
linenumberstrue
{
  "site":{"name":"Porder Drive"},
  "collectionProtocol":{"shortTitle":"LCP"},
  "role":{"name":"Technician"}
}
Response 
Code Block
languagejs
themeEclipse
linenumberstrue
{
  "id":null,
  "role": {
      "id":4,
      "name":"Technician",
      "description":"User who collects and processes specimens.",
      "parentRoleName":null,
      "childRoles":[],
      "acl":[
         {"id":14,"resourceName":"StorageContainer","operations":[{"resourceInstanceId":null,"operationName":"Read"}]},
         {"id":44,"resourceName":"ShippingAndTracking",
           "operations":[
             {"resourceInstanceId":null,"operationName":"Create"},
             {"resourceInstanceId":null,"operationName":"Update"},
             {"resourceInstanceId":null,"operationName":"Delete"},
             {"resourceInstanceId":null,"operationName":"Read"}]},
         {"id":15,"resourceName":"CollectionProtocol","operations":[{"resourceInstanceId":null,"operationName":"Read"}]},
         {"id":18,"resourceName":"Order",
            "operations":[
              {"resourceInstanceId":null,"operationName":"Read"},{"resourceInstanceId":null,"operationName":"Create"},
              {"resourceInstanceId":null,"operationName":"Delete"},{"resourceInstanceId":null,"operationName":"Update"}]},
        {"id":17,"resourceName":"VisitAndSpecimen",
          "operations":[
             {"resourceInstanceId":null,"operationName":"Delete"},
             {"resourceInstanceId":null,"operationName":"Read"},
             {"resourceInstanceId":null,"operationName":"Create"},
             {"resourceInstanceId":null,"operationName":"Update"}]},
       {"id":16,"resourceName":"ParticipantDeid","operations":[{"resourceInstanceId":null,"operationName":"Read"}]}
     ]
   },
   "collectionProtocol":{"id":52,"shortTitle":"LCP","title":"Lung Cancer Protocol","code":"LP","principalInvestigator":{"id":1,"firstName":"Admin","lastName":"Admin","loginName":"admin@admin.com","domain":"openspecimen","emailAddress":"openspecimendemo@gmail.com","admin":true,"cpCount":0,"creationDate":null},"startDate":1446661800000,"endDate":null,"participantCount":null,"specimenCount":null,"ppidFmt":"LP-%04d","manualPpidEnabled":true},"},
   "site":{"id":35,"name":"3165 Porder Drive","instituteName":"Stanford","code":"PD","type":"Collection Site","activityStatus":"Active","cpCount":0,"coordinators":[{"id":1,"firstName":"Admin","lastName":"Admin","loginName":"admin@admin.com","domain":"openspecimen","emailAddress":"openspecimendemo@gmail.com","admin":true,"cpCount":0,"creationDate":null}],"address":null,"extensionDetail":null},",
   "systemRole":false
}

 Error Cases :

code
Applies to
Status Message
200All resourcesUser Role has been updated assigned successfully to user
400All requestsInvalid parameters, e.g  duplicate login name, duplicate email address, blank first name site, cp, role etc
401All requestsAuthorization failed, user doesn’t have authority to assign role
404All requestsUser not found, user with given details not present in the system
500All requestsInternal server error, encountered server error while performing operations

...