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 .xml suffix or ?format=xml

HTTP + XML

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

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

<UpdateUserRegistrationPasswordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.UserRegistration">
  <Requester xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Interfaces">String</Requester>
  <CustomerBrandName>String</CustomerBrandName>
  <Email>String</Email>
  <NewPassword>String</NewPassword>
  <SendResetEmail>false</SendResetEmail>
</UpdateUserRegistrationPasswordRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateUserRegistrationPasswordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.UserRegistration">
  <DisplayName>String</DisplayName>
  <Id>0</Id>
  <ResetEmailSent>false</ResetEmailSent>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UpdateUserRegistrationPasswordResponse>