Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/account/editProfilePOST


Data Models: UsersGroups 

Workflow: Edit Profile Workflow

Input

...

NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/A 
usernameBodyYESStringalphanumeric with _ , - characters only 
firstNameBodyYESStringN/A 
lastNameBodyYESStringN/A 
profileBodyNOStringN/Aa stringified object.

 

Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": true
}

...

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[405],
        "details":[
            {
                "code":405,
                "message":"Unable to find User. Please try again."
            }
        ]
    }
}



Error Codes


 

Code
Description
405Unable to find User. Please try again.
407Problem validating Request. Please try again.
410username taken, please choose another username
411invalid user id provided
413Invalid profile field provided. Profile should be a stringified object.
415Unable to find group.
500This record in locked. You cannot modify or delete it

Example (CURL)

...

Request

Code Block
languagebash
titleCalling Edit Profile API
 > CURL -X POST http://127.0.0.1:4000/urac/account/editProfile?uId=123 -d "username=john&firstName=John&lastName=Doe&profile={'gender':'male'}"

...