Versions Compared

Key

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

...

...

General Information

...

ServiceAPIMethodData ModelsWorkflow
urac

/validate/join

GETUsersN/A

Description

This API is to validate the user's account after joining.

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
tokenQueryYESStringN/AToken


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: true: {
  	_id: "%user_id%",
	username: "%username%",
	email: "%user_email%"
  }
}

Invalid Response

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

Response schema

Follow this link to check out the response JSON response JSON Schema

SOAJS Error Codes



Code
Description
400

Business logic required data are missing

520

Unable to find user

599

Token has expired

600

unable to find token

602Model error: + %model_error%