PortfolioLinkApi

<back to all web services

CreateUser

Requires Authentication
Required permission:manageUsers
The following routes are available for this service:
POST/users/create
CreateUser Parameters:
NameParameterData TypeRequiredDescription
AppNamebodystringNo
KeyIdbodystringNo
UserNamebodystringNo
PasswordbodystringNo
ConfirmPasswordbodystringNo
SignaturebodystringNo
FirstNamebodystringNo
LastNamebodystringNo
EmailbodystringNo
DisplayNamebodystringNo
PartnerIdbodyintNo
RegisterResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformstringNo
SessionIdformstringNo
UserNameformstringNo
ReferrerUrlformstringNo
BearerTokenformstringNo
RefreshTokenformstringNo
ResponseStatusformResponseStatusNo
MetaformDictionary<string, string>No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /users/create HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"appName":"String","keyId":"String","userName":"String","password":"String","confirmPassword":"String","signature":"String","firstName":"String","lastName":"String","email":"String","displayName":"String","partnerId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"userId":"String","sessionId":"String","userName":"String","referrerUrl":"String","bearerToken":"String","refreshToken":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}