...
Error | ResponseType |
---|---|
Missing attributes:
| JSON (validation error) |
Password complexity | JSON (validation error) |
...
Change Password
Actionname: | updatechangepassword | |||
Example-URL | {YOUR_APP_URL}/$dwo3rd-userregistry-api/profileserviceregistration?action=updatechangepassword | |||
Purpose: | Update UserProfile Changes the password of the current User with supplied valuesuser | |||
Method: | POST | |||
Payload | updated UserProfile | Response | ProfileOkResponse | { oldpasswort: "suppipw", } |
Response | JSON Response with status or validation error |
Possible Errors
Error | ResponseType |
---|---|
Validation Failed | ValidationFailedResponse |
Exception was thrown | ExceptionResponse |
Failed to save updated Profile | ErrorResponse |
...
Missing attributes:
| JSON (validation error) |
Password complexity | JSON (validation error) |
Forgotten Password
Actionname: | registernewpassword |
Example-URL | {YOUR_APP_URL}/$dwo3rd-userregistry-api/profileserviceregistration?action=registernewpassword |
Purpose: | Creates Asks for a new UserProfile with the supplied valuespassword |
Method: | POST |
Payloadnew UserProfile | { } |
ResponseEmptyOkResponse | JSON Response with status or validation error |
Possible Errors
Error | ResponseType |
---|---|
Validation Failed | ValidationFailedResponse |
Exception was thrown | ExceptionResponse |
...
No User found with current mailadress | JSON (validation error) |
Activate new password
Actionname: | activateactivatenewpassword |
Example-URL | {YOUR_APP_URL}/$dwo3rd-userregistry-api/profileserviceregistration?action=newpassword?action=activateactivatenewpassword&cid=50M3-R4ND0M-K3Yid={confirmationid} |
Purpose:Activates an already registered User | Resets the passwort to a new one |
Method: | GETPOST |
ParameterconfirmationId | { password: 'newpw', } |
ResponseProfileOkResponse | JSON Response with status or validation error |
Possible Errors
Error | ResponseType |
---|---|
Exception was thrownPassword complexity | ExceptionResponse |
No request with this id |
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 | |
profileaction | Object | The UserProfile Data; Datalayout see OverviewString | Current executed action | yes |
Responsetypes Success
...