Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/admin/getUserGET


Data Model: Users

Workflow: Get User

Input

...

NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/Athe user id

 

Output

...

Valid Response

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

...

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[411],
        "details":[
            {
                "code":411,
                "message":"invalid user id provided"
            }
        ]
    }
}



Error Codes


 

Code
Description
405Unable to find User. Please try again.
411invalid user id provided


Example (CURL)

...

Request

Code Block
languagebash
titleCalling Get User API
 > CURL -X GET http://127.0.0.1:4000/urac/admin/getUser?uId=5718a32f0e811ab5a0ca08b3 

...