Registrar Web Services

<back to all web services

UpdateUserRegistrationPasswordRequest

Admin Portal can use this to reset a customers password

Requires Authentication
Required roles:Admin, Admin
The following routes are available for this service:
POST/UpdateUserRegistrationPassword
UpdateUserRegistrationPasswordRequest Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringYesCustomers Email Address
NewPasswordbodystringYesNew Password
SendResetEmailbodyboolNoTrue if you want to send a Login Updated Email
CustomerBrandNamebodystringNoBrandName associated with the customer
BaseAdminRequest Parameters:
NameParameterData TypeRequiredDescription
RequesterformstringNoIdentity of the caller
UpdateUserRegistrationPasswordResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IdformlongNo
DisplayNameformstringNo
ResetEmailSentformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/UpdateUserRegistrationPasswordRequest HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/json
Content-Length: length

{"Email":"String","NewPassword":"String","SendResetEmail":false,"CustomerBrandName":"String","Requester":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Id":0,"DisplayName":"String","ResetEmailSent":false}