...
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 |
...
| 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 |
| ParameterPayload | updated UserProfile |
| Response | ProfileOkResponse |
...
| 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 |
| ParameterPayload | new UserProfile |
| Response | EmptyOkResponse |
...
| 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 |
...