Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

This API is useful for mainly Update the user. You can update user through the HTTP PUT URL  http://<host>:<port>/catissuecore/rest/ng/users/{userId}

 

Below are the attributes which need to be sent in the request body:

Parameter
Details
userIdUser Id of the user
firstNameFirst name of the user
middleNameMiddle name of the user
domainNameIt is the name of the authentication domain. You cannot able to change domain of the user once user created  
emailAddressEmail Address of the user. This attribute should be unique in catissue application
loginName

Login Name through which user can login to catissue application, should be unique in authentication domains.

You cannot able to change domain of the user once user created

siteNamesName of the sites to which the user belongs
cpTitlesName of the collection protocols to which user belongs.
activityStatus

Activity status of the user, permissible values are

{active, closed, pending, disabled}

deptNameName of department to which user belongs
comments [optional]comments on user given by admin while approval
countryCountry of the user
state [optional]state of the user
city [optional]city of the user
zipCodezipCode of the user
phoneNumber [optional]Phone number of the user
faxNumber [optional]Fax number of the user


API Example :

URLcatissuecore/rest/ng/users/{userId}
MethodPUT
Requestapplication/json
json{
    "lastName":"Piterson",
    "firstName":"Sam",
    "domainName":"catissue",
    "emailAddress":"sam.piterson@live.com",
    "loginName":"samPiterson",
    "siteNames":["My group", "New Site"],
    "cpTitles":["MyCp", "Test Cp"],
    "activityStatus":"Active",
    "deptName":"Department of onchology",
    "comments":"bla bla bla",
    "city":"Jalgaon",
    "state":"Maharashtra",
    "country":"India",
    "zipCode":"425022",
    "faxNumber":"434343AS",
    "phoneNumber":"654323",
}

Response

{

    "id" : "1",
    "lastName":"Piterson",
    "firstName":"Sam",
    "domainName":"catissue",
    "emailAddress":"sam.piterson@live.com",
    "loginName":"samPiterson",
    "siteNames":["My group", "New Site"],
    "cpTitles":["MyCp", "Test Cp"],
    "activityStatus":"Active",
    "deptName":"Department of onchology",
    "comments":"bla bla bla",
    "city":"Jalgaon",
    "state":"Maharashtra",
    "country":"India",
    "zipCode":"425022",
    "faxNumber":"434343AS",
    "phoneNumber":"654323"
}

 

 Error Cases :

code
Applies to
Status Message
200All resourcesUser has been updated successfully
400All requestsInvalid parameters, e.g  duplicate Login Name, duplicate Email Address, blank First Name etc
401All requestsAuthorization failed, User doesn’t have Authority
404All requestsUser not found, User with given details not present in the system
500All requestsInternal server error, Encountered server error while performing operations

 

 

 

  • No labels