Versions Compared

Old Version 1

changes.mady.by.user peter eid (Unlicensed)

Saved on

compared with

New Version 2

changes.mady.by.user peter eid (Unlicensed)

Saved on

Key

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

General Information

...

ServiceAPIMethod
urac/admin/changeUserStatusGET


Data Model: %Link to Data Model% Users

Workflow: %Link to Architecture Page%

...

Body 
NameSourceMandatoryTypeSpecial FormatDescription 
uIdQueryYESStringN/Athe user id
statusQueryYESStringN/Arestricted to either 'active' OR 'inactive'

 

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.
407Problem validating Request. Please try again.
411invalid user id provided


Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR Change User Status API
 > CURL -X POSTGET http://127.0.0.1:4000/.../urac/admin/changeUserStatus?uId=123&status=active

Response

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