Versions Compared

Key

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

General Information

...

ServiceAPIMethodData ModelsWorkflow
urac/admin/users/countGET

...

...

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
keywordsQueryNOStringN/AApplied towards: email, username, firstName, or lastName


Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Code Block
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{ 
  	"result": true,
	"data": { 		"count"data: 12
	}2
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result":false,
    "errors":{
        "codes":[400602],
        "details":[
            {
                "code": 400602,
                "message":"Model "Databaseerror: connection+ error%model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


...


Code
Description
400
Database connection error
Example (CURL)

Request

Code Block
languagebash
titleCalling List Users API
 > CURL -X GET http://127.0.0.1:4000/urac/admin/users/count

Response

...

languagejs
titleList Users API response

Business logic required data are missing

602Model error: + %model_error%