Account Settings Delete Request (AccountSettingsDeleteRequest) Class
The AccountSettingsDeleteRequest class is designed to send a request to the server to delete specific account settings for a client. This is typically used when an account's visibility preference needs to be removed or reset, rather than just toggled.
Purpose
This model is used when the system needs to explicitly remove a previously set account visibility preference. For example, if an account is closed or if its settings should revert to a default state, this request would be used.
Properties
The AccountSettingsDeleteRequest class has the following properties:
| Property Name | Type | Required | JSON Property Name | Description |
|---|---|---|---|---|
Gcn | string | Yes | gcn | The Global Client Number, identifying the client whose account setting is to be deleted. |
AccountNumber | string | Yes | accountNumber | The unique identifier for the account whose setting is to be deleted. |
AccountType | string | Yes | accountType | The type of account (e.g., Savings, Cheque) whose setting is to be deleted. |
Validation
- All properties (
Gcn,AccountNumber,AccountType) are required fields, enforced by the[Required]attribute.
Example Usage (C#)
This example demonstrates how to create an instance of AccountSettingsDeleteRequest:
using Investec.AccountSettings.Models;
var deleteRequest = new AccountSettingsDeleteRequest
{
Gcn = "123456789",
AccountNumber = "ACC001",
AccountType = "Cheque"
};
// This 'deleteRequest' object would then be serialized (typically to JSON)
// and sent as the body of an HTTP DELETE or POST request (depending on API design)
// to the Account Settings API to remove the visibility preference for the specified account.This request targets a specific account for a specific client to have its visibility settings record removed from the system.