PortfolioLinkApi

<back to all web services

AddUser

Requires Authentication
The following routes are available for this service:
All Verbs/user/management/create
AddUser Parameters:
NameParameterData TypeRequiredDescription
EmailquerystringNo
PhoneNumberquerystringNo
BlockedqueryboolNo
EmailVerifiedqueryboolNo
PhoneVerifiedqueryboolNo
GivenNamequerystringNo
FamilyNamequerystringNo
UserIdquerystringNo
ConnectionquerystringNo
PasswordquerystringNo
VerifyEmailqueryboolNo
UsernamequerystringNo
AddUserResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /user/management/create HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String,
	phoneNumber: String,
	blocked: False,
	emailVerified: False,
	phoneVerified: False,
	givenName: String,
	familyName: String,
	userId: String,
	connection: String,
	password: String,
	verifyEmail: False,
	username: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	success: False
}