Page tree

Versions Compared

Key

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

...

The ProfileRegistry Service is reachable at: {YOUR_APP_URL}/api/profileservice


Actions

MyProfile

Actionname:myprofile
Purpose:Retrieve the UserProfile for the currently logged in User
Method:GET
Parameter-
ResponseProfileOkResponse

Possible Errors

ErrorResponseType
Profile not foundErrorResponse

Update

Actionname:update
Purpose:Update UserProfile of the current User with supplied values
Method:POST
Parameterupdated UserProfile
ResponseProfileOkResponse

Possible Errors

ErrorResponseType
Validation FailedValidationFailedResponse
Exception was thrownExceptionResponse
Failed to save updated ProfileErrorResponse

Register

Actionname:register
Purpose:Creates a new UserProfile with the supplied values
Method:POST
Parameternew UserProfile
ResponseEmptyOkResponse

Possible Errors

ErrorResponseType
Validation FailedValidationFailedResponse
Exception was thrownExceptionResponse

Activate

Actionname:activate
Purpose:Activates an already registered User
Method:GET
ParameterconfirmationId
ResponseProfileOkResponse

Possible Errors

ErrorResponseType
Exception was thrownExceptionResponse

Response

Data

The Response can contain following fields, please refer to the Responsetable below for more information about the Response contents.

FieldnameTypeContentoptional
statusStringthe status of the requestno
errorStringThe Error clearnameyes
messagesArray of String

Messages related to this request

yes
traceStringThe Stacktrace of the error as a Stringyes
profileObjectThe UserProfile Data; Datalayout see Overviewyes

 

Actions

MyProfile

Actionname:myprofile
Purpose:Retrieve the UserProfile for the currently logged in User
Method:GET
Parameter-
ResponseProfileOkResponse

Possible Error

Responses

 

 

Update

 

 

Register

 

Activate

Responses

Responsetypes Success

NameFieldsStatus
ProfileOkResponsestatus, profileok
EmptyOkResponsestatusok

ResponseTypes Error

NameFieldsStatus
ErrorResponsestatus, errorerror
ExceptionResponsestatus, error, trace, profileerror
ValidationFailedResponsestatus, error, messages, profilevalidationfailed

...