Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

General Information


ServiceAPIMethodData ModelsWorkflow
urac/joinPOSTUsersN/A

Description

This API allows guest to join (create an account).

Input


Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
usernameBodyYESString
  1. Alphanumeric
  2. Minimum Length: 5
  3. maxLength: 50
Username
passwordBodyYESStringN/APassword
emailBodyYESStringEmail formatEmail
firstNameBodyYESStringN/AFirst Name
lastNameBodyYESStringN/ALast Name
profileBodyNOObjectN/Aadditional information


Output


Response

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

Valid Response

Valid Response Sample
{ 
  result: true,
  data:
   {
	id: '%new_user_ID%', 
	token: %token%,
     link:
      { join:
         'http://dashboard.soajs.org/#/join?token=%token%'
      }
   }
}

Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


Code
Description
400

Business logic required data are missing

524

Cannot join with a sub tenant key

602Model error: + %model_error%
  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.