Versions Compared

Old Version 1

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

Saved on

compared with

New Version Current

changes.mady.by.user Fadi Nasr (Unlicensed)

Saved on

Key

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

General Information

...

ServiceAPIMethod
urac/join/validateGET


Data Model: %Link to Data Model%

Workflow: %Link to Architecture Page%

Input

Models: Users, Tokens

workflow: Validate Join Flow


Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
 
token
Body
QueryYESStringN/A
 

...

Generated by Urac and email to user after registration is completed.


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":[400406],
        "details":[
            {
                "code":400406,
                "message":"ProblemInvalid withor thetoken providedhas passwordexpired."
            }
        ]
    }
}



Error Codes


 

Code
Description
400Database Error
406Invalid or token has expired.
407Problem validating Request. Please try again.


Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR Validate API
 > CURL -X POSTGET http://127.0.0.1:4000/...urac/join/validate?token=abcdef

Response

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