Click or drag to resize

AccountClient Methods

The AccountClient type exposes the following members.

Methods
  NameDescription
Public methodCode exampleAccountActivation
Activates a specified Account using a valid Account Activation Request RSN.
Remarks
  • Current Account Status must be Activation Pending
  • Account Activation Request RSN has an expiry of a configurable value, and must be used within this timeframe to be valid
  • Account Activation Request RSN is generated by the Web Service Method: Request Management Group Account Activation
Public methodCode exampleAccountPasswordReset
Enables an Account holder to set the Account Password using a valid Reset Password Request RSN.
Remarks
  • Current Account Status must be Active
  • Reset Password Request RSN has an expiry of a configurable value, and must be used within this timeframe to be valid
  • New Password must adhere to the Password Rules
  • Reset Password Request RSN is generated by the Web Service Method: Request Management Group Account Password Request
Public methodCode exampleManagementGroupAuthenticate

Validates the Token submitted, and returns a small set of Account Details.

A new Token is issued, which is to be used for calling Web Service Methods that require Token Authentication.

Remarks
  • The Token used to call this Web Service Method will be expired. Ensure the new Token issued is used for calling Web Service Methods that require Token Authentication.
  • The new Token issued has an expiry of a configurable value, and must be used within this timeframe to be valid
Public methodCode exampleManagementGroupLogin

Validates Account Credentials. If the Account Credentials are valid, then a Token is returned, along with the a small set of Account Details.

An Authenticated Token will allow the the Account holder access to Web Service Methods that require Token Authentication.

Remarks
  • Account Status must be Active
Public methodCode exampleManagementGroupLoginActiveMembershipOnly

Validates Account Credentials. If the Account Credentials are valid, then a Token is returned, along with the a small set of Account Details.

An Authenticated Token will allow the the Account holder access to Web Service Methods that require Token Authentication.

Remarks
  • Account Status must be Active
Public methodCode exampleManagementGroupLogout

Logout an Account. The current Token will be expired, and no longer available for use.

Public methodCode exampleManagementGroupValidate

Validates the Token submitted, and returns the Account RSN linked to the Token.

Public methodCode exampleRequestManagementGroupAccountActivation

Generates an Account Activation Request RSN.

The Account Activation Request RSN value can be passed to the Web Service Method: Account Activation to set an Account Status to Active.

Remarks
  • Current Account Status must be Activation Pending
  • Email will be sent to the Account Email Address. The Email has a link that to an Activate Account Web Page that includes the Account Activation Request RSN value
  • Account Activation Request RSN has an expiry of a configurable value, and must be used within this timeframe to be valid
Public methodCode exampleRequestManagementGroupAccountPasswordReset

Generates a Reset Password Request RSN, facilitating Reset Forgotten Password function for an Account.

The Reset Password Request RSN value can be passed to the Web Service Method: Account Password Reset to enable the Account holder to change their Password.

Remarks
  • Current Account Status must be Active
  • Email will be sent to the Account Email Address. The Email has a link that to a Reset Password Web Page that includes the Reset Password Request RSN value
  • Reset Password Request RSN has an expiry of a configurable value, and must be used within this timeframe to be valid
Public methodCode exampleUpdateAccountPassword
Enables an Account holder to set the Account Password using a valid Token.
Remarks
  • Current Account Status must be Active
  • Token has an expiry of a configurable value, and must be used within this timeframe to be valid
  • New Password must adhere to the Password Rules
  • Token is supplied from Web Service Methods: Management Group Login or Management Group Authenticate
Top
See Also