Page tree

Versions Compared

Key

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

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:Retrieve the UserProfile for the currently logged in UserSelfregistration of a user
Method:POST
Parameter

{

firstname: "Hans",
lastname: "Muster",
email: "hans.muster@acme.com",
password: "supersecrete",

confiormation: "supersecrete"

}

Response

JSON Response with status or validation error

Mail is send to activate the user

Possible Errors

ErrorResponseType
Missing attributes:
  • firstname
  • lastname
  • email
  • password
  • conformation
JSON (validation error)
Password complexityJSON (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",
lastname: "Muster",
email: "hans.muster@acme.com",
}

Response

JSON Response with status or validation error

Mail is send to accept the invitation

Possible Errors

ErrorResponseType
Missing attributes:
  • firstname
  • lastname
  • email
JSON (validation error)
E-Mail send errorJSON (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
Parameterid={confirmationid} --> id of the confirmation mail
ResponseProfileOkResponse

JSON Response with status or validation error

Mail is send to accept the invitation

Possible Errors

ErrorResponseType
Profile not foundErrorResponse
No User found for this confirmation idJSON (validation error)
User is already activeJSON (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",
lastname: "Muster",
password: "supersecrete"
confirmation: "supersecrete"
}

Response

JSON Response with status or validation error

Mail is send to accept the invitation

Possible Errors

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

Possible Errors

ErrorResponseType
Validation FailedValidationFailedResponse
Exception was thrownExceptionResponse
Failed to save updated ProfileErrorResponse

Register

Actionname:register
Example-URL{YOUR_APP_URL}/api/profileservice?action=register
Purpose:Creates a new UserProfile with the supplied values
Method:POST
Payloadnew UserProfile
ResponseEmptyOkResponse

Possible Errors

ErrorResponseType
Validation FailedValidationFailedResponse
Exception was thrownExceptionResponse

Activate

Actionname:activate
Example-URL{YOUR_APP_URL}/api/profileservice?action=activate&cid=50M3-R4ND0M-K3Y
Purpose:Activates an already registered User
Method:GET
ParameterconfirmationId
ResponseProfileOkResponse

Possible Errors

ErrorResponseType
Exception was thrownExceptionResponse

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
profileObjectThe UserProfile Data; Datalayout see Overviewyes

 

Responsetypes Success

NameFieldsStatus
ProfileOkResponsestatus, profileok
EmptyOkResponsestatusok

ResponseTypes Error

NameFieldsStatus
ErrorResponsestatus, errorerror
ExceptionResponsestatus, error, trace, profileerror
ValidationFailedResponsestatus, error, messages, profilevalidationfailed

Guides

Children Display