Basics
The ProfileRegistry UserRegistry Service is reachable at: {YOUR_APP_URL}/$dwo3rd-userregistry-api/profileserviceregistration)
Actions
...
Selfregistration
| Actionname: | myprofileregister | ||
| Example-URL | {YOUR_APP_URL}/$dwo3rd-userregistry-api/profileserviceregistration?action=myprofileregister | ||
| Purpose: | Selfregistration of a user | ||
| Method: | Retrieve the UserProfile for the currently logged in User | POST | |
| Parameter | { firstname: "Hans", } | ||
| Response | JSON Response with status or validation error Mail is send to activate the user |
Possible Errors
| Error | ResponseType |
|---|---|
Missing attributes:
| JSON (validation error) |
| Password complexity | JSON (validation error) |
Invitation
| Actionname: | invite |
| Example-URL | {YOUR_APP_URL}/$dwo3rd-userregistry-api/registration?action=invite |
| Purpose: | Invitation for a user |
| Method: | POST |
| Parameter | { firstname: "Hans", |
| Response | JSON Response with status or validation error Mail is send to accept the invitation |
Possible Errors
| Error | ResponseType |
|---|---|
Missing attributes:
| JSON (validation error) |
| E-Mail send error | JSON (validation error) |
Activate my User
| Actionname: | activate |
| Example-URL | {YOUR_APP_URL}/$dwo3rd-userregistry-api/registration?action=activate&id={confirmationid} |
| Purpose: | Activate a user after selfregistration |
| Method: | GET |
| Parameter | id={confirmationid} --> id of the confirmation mail |
| Response | JSON Response ProfileOkResponsewith status or validation error Mail is send to accept the invitation |
Possible Errors
| Error | ResponseType | Profile not found |
|---|---|---|
| ErrorResponseNo User found for this confirmation id | JSON (validation error) | |
| User is already active | JSON (validation error) |
Activate an invited user
| Actionname: | activateinviteduser |
| Example-URL | {YOUR_APP_URL}/$dwo3rd-userregistry-api/registration?action=activateinviteduser&id={confimationid} |
| Purpose: | Finalize the registration of an invited user |
| Method: | POST |
| Parameter | { firstname: "Hans", |
| Response | JSON Response with status or validation error Mail is send to accept the invitation |
Possible Errors
| Error | ResponseType |
|---|---|
Missing attributes:
| JSON (validation error) |
| Password complexity | JSON (validation error) |
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
| Children Display |
|---|