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/joinPOST


Data Model: %Link to Data Model%Models: Users, Tokens

Workflow: %Link to Architecture Page%

...

NameSourceMandatoryTypeSpecial FormatDescription
usernameBodyYESStringalphanumeric with _ , - characters only 
passwordBodyYESStringN/A 
firstNameBodyYESStringN/A 
lastNameBodyYESStringN/A 
emailBodyYESStringN/A 

 

Output

...

Valid Response

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

 

Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[400402],
        "details":[
            {
                "code":400402,
                "message":"ProblemUser withaccount the provided passwordalready exists."
            }
        ]
    }
}



Error Codes

 

400
Code
Description
402User account already exists.
403Database Error


Example (CURL)

...

Code Block
languagebash
titleCalling YOUR Join API
 > CURL -X POST http://127.0.0.1:4000/urac/...join -d 'username=john&password=johnpassword&firstName=John&lastName=Doe&email=johndoe@domain.com'

Response

Code Block
languagejs
titleYOUR Join API response
{
	"result": true,
	"data": { 		"_id": "57063608622c47b5c097d19b",
		"..."
	}"819b0aed-edd8-47d5-ada0-9e5f93cb8248"
}