Page tree

Versions Compared

Key

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

...

ErrorResponseType
Missing attributes:
  • firstname
  • lastname
  • password
  • confirmation
JSON (validation error)
Password complexityJSON (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
Payloadupdated UserProfileResponseProfileOkResponse

{

oldpasswort: "suppipw",
passoword:"newsuppipw",
confirmation:"newsuppipw"

}

ResponseJSON Response with status or validation error

Possible Errors

ErrorResponseType
Validation FailedValidationFailedResponse
Exception was thrownExceptionResponse
Failed to save updated ProfileErrorResponse

Register

Actionname:register

 Missing attributes:

  • oldpassword
  • password
  • confirmation
JSON (validation error)
Password complexityJSON (validation error)
  

Forgotten Password

Actionname:newpassword
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 UserProfileResponseEmptyOkResponse

{
email:"hans.muster@acme.com"

}

ResponseJSON Response with status or validation error

Possible Errors

ErrorResponseType
Validation FailedValidationFailedResponse
Exception was thrownExceptionResponse

...

No User found with current mailadressJSON (validation error)
  

Activate new password

Actionname:activateactivatenewpassword
Example-URL{YOUR_APP_URL}/$dwo3rd-userregistry-api/profileserviceregistration?action=activate&cid=50M3-R4ND0M-K3Ynewpassword?action=activatenewpassword&id={confirmationid}
Purpose:Activates an already registered UserResets the passwort to a new one
Method:GETPOST
ParameterconfirmationIdResponseProfileOkResponse

{

password: 'newpw',
confirmation: 'newpw'

}

ResponseJSON Response with status or validation error

Possible Errors

ErrorResponseType
Exception was thrownPassword complexityExceptionResponse
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.

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
profileactionObjectThe UserProfile Data; Datalayout see OverviewStringCurrent executed actionyes

 

Responsetypes Success

...