UserPassword - LorenData/ECGrid-API GitHub Wiki

Back To Common API Calls

Update a User's security information.

  public boolean UserPassword(string SessionID,
                              int UserID,
                              string CurrentRecoveryAnswer,
                              string Password,
                              string RecoveryQuestion,
                              string RecoveryAnswer)

Parameters

Returns

boolean

Remarks

Loren Data requires strong passwords that include at least one uppercase, one lowercase, one number and one special character. For example This1IsGood!

Code Example

C#

using System.Xml;
using System.Web.Services.Protocols;
using ECGridService = <ProjectName>.net.ecgridos;

try
{
    using (ECGridService.ECGridOSAPIv3 ECGrid = new ECGridService.ECGridOSAPIv3())
    {
        try
        {
            string SessionID = "00000000-0000-0000-0000-000000000000";
            int UserID = 461743;
            string CurrentRecoveryAnswer = "Current Answer";
            string Password = "New Password";
            string RecoveryQuestion = "New Recovery Question";
            string RecoveryAnswer = "New recover Answer";

            bool UserResults = ECGrid.UserPassword(SessionID, UserID, CurrentRecoveryAnswer, Password,RecoveryQuestion, RecoveryAnswer);

        }
        catch (SoapException SoapEx)
        {
            // See SOAP Exceptions in the Appendix
            var ECG_Ex = CatchException(SoapEx);
            Console.WriteLine($"ECGridOS Soap Exception: {ECG_Ex.ErrorCode} , Item: {ECG_Ex.ErrorItem}, Message: {ECG_Ex.ErrorMessage}, String: {ECG_Ex.ErrorString}");
        }
    } // END USING
}
catch (Exception ex){ Console.WriteLine("Unhandled Exception: " + ex.ToString()); }

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://os.ecgrid.io/UserPassword"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UserPassword xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <UserID>int</UserID>
      <CurrentRecoveryAnswer>string</CurrentRecoveryAnswer>
      <Password>string</Password>
      <RecoveryQuestion>string</RecoveryQuestion>
      <RecoveryAnswer>string</RecoveryAnswer>
    </UserPassword>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UserPasswordResponse xmlns="https://os.ecgrid.io/">
      <UserPasswordResult>boolean</UserPasswordResult>
    </UserPasswordResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UserPassword xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <UserID>int</UserID>
      <CurrentRecoveryAnswer>string</CurrentRecoveryAnswer>
      <Password>string</Password>
      <RecoveryQuestion>string</RecoveryQuestion>
      <RecoveryAnswer>string</RecoveryAnswer>
    </UserPassword>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UserPasswordResponse xmlns="https://os.ecgrid.io/">
      <UserPasswordResult>boolean</UserPasswordResult>
    </UserPasswordResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v4.1/prod/ECGridOS.asmx/UserPassword?SessionID=string&UserID=string&CurrentRecoveryAnswer=string&Password=string&RecoveryQuestion=string&RecoveryAnswer=string HTTP/1.1
Host: os.ecgrid.io

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="https://os.ecgrid.io/">boolean</boolean>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v4.1/prod/ECGridOS.asmx/UserPassword HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&UserID=string&CurrentRecoveryAnswer=string&Password=string&RecoveryQuestion=string&RecoveryAnswer=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="https://os.ecgrid.io/">boolean</boolean>

Back To Common API Calls

⚠️ **GitHub.com Fallback** ⚠️