You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Basics
The ProfileRegistry Service is reachable at: {YOUR_APP_URL}/api/profileservice
Actions
MyProfile
Actionname: | myprofile |
Example-URL | {YOUR_APP_URL}/api/profileservice?action=myprofile |
Purpose: | Retrieve the UserProfile for the currently logged in User |
Method: | GET |
Parameter | - |
Response | ProfileOkResponse |
Possible Errors
Error | ResponseType |
---|
Profile not found | ErrorResponse |
Update
Actionname: | update |
Example-URL | {YOUR_APP_URL}/api/profileservice?action=update |
Purpose: | Update UserProfile of the current User with supplied values |
Method: | POST |
Payload | updated UserProfile |
Response | ProfileOkResponse |
Possible Errors
Error | ResponseType |
---|
Validation Failed | ValidationFailedResponse |
Exception was thrown | ExceptionResponse |
Failed to save updated Profile | ErrorResponse |
Register
Actionname: | register |
Example-URL | {YOUR_APP_URL}/api/profileservice?action=register |
Purpose: | Creates a new UserProfile with the supplied values |
Method: | POST |
Payload | new UserProfile |
Response | EmptyOkResponse |
Possible Errors
Error | ResponseType |
---|
Validation Failed | ValidationFailedResponse |
Exception was thrown | ExceptionResponse |
Activate
Actionname: | activate |
Example-URL | {YOUR_APP_URL}/api/profileservice?action=activate&cid=50M3-R4ND0M-K3Y |
Purpose: | Activates an already registered User |
Method: | GET |
Parameter | confirmationId |
Response | ProfileOkResponse |
Possible Errors
Error | ResponseType |
---|
Exception was thrown | ExceptionResponse |
Response
Data
The Response can contain following fields, please refer to the Responsetable below for more information about the Response contents.
Fieldname | Type | Content | optional |
---|
status | String | the status of the request | no |
error | String | The Error clearname | yes |
messages | Array of String | Messages related to this request | yes |
trace | String | The Stacktrace of the error as a String | yes |
profile | Object | The UserProfile Data; Datalayout see Overview | yes |
Responsetypes Success
Name | Fields | Status |
---|
ProfileOkResponse | status, profile | ok |
EmptyOkResponse | status | ok |
ResponseTypes Error
Name | Fields | Status |
---|
ErrorResponse | status, error | error |
ExceptionResponse | status, error, trace, profile | error |
ValidationFailedResponse | status, error, messages, profile | validationfailed |
Guides