Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/account/editProfilePOST


Data Model: %Link to Data Model%Models: UsersGroups 

Workflow: %Link to Architecture Page%

...

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
}

 

Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[400405],
        "details":[
            {
                "code":400405,
                "message":"Problem with the provided passwordUnable to find User. Please try again."
            }
        ]
    }
}



Error Codes


 

Database Error
Code
Description
400
405Unable to find User. Please try again.
411invalid user id provided
415Unable to find group.
500This record in locked. You cannot modify or delete it


Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR 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'}"

Response

Code Block
languagejs
titleYOUR API response
{
	"result": true,
	"data": {
		"_id": "57063608622c47b5c097d19b",
		"..."
	}true
}