Net3 API Interface for Customer Portal

<back to all web services

ChangePassword

Requires Authentication
The following routes are available for this service:
PUT/logins/ChangePassword
ChangePassword Parameters:
NameParameterData TypeRequiredDescription
userIdbodyGuidNo
passwordbodystringNo
newPasswordbodystringNo
DTOBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
ChangePasswordResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExecuteResult<Result>No
ResponseStatusformResponseStatusNo
ExecuteResult<T> Parameters:
NameParameterData TypeRequiredDescription
HasErrorformboolNo
MessageformstringNo
ResultformTNo
ExceptionformExceptionNo
Result Enum:
Fail
Success
Error

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.

PUT /logins/ChangePassword HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ChangePassword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <sessionId>String</sessionId>
  <newPassword>String</newPassword>
  <password>String</password>
  <userId>00000000-0000-0000-0000-000000000000</userId>
</ChangePassword>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ChangePasswordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <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>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Common">
    <d2p1:Exception xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL i:nil="true" xmlns="" />
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">-2146233088</HResult>
      <Source i:nil="true" xmlns="" />
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:HasError>false</d2p1:HasError>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:Result>Fail</d2p1:Result>
  </Result>
</ChangePasswordResponse>