Get Recipients LocalDB Data Block

The Get Recipients LocalDB (GetRecipientsLocalDB) Data Block is designed to retrieve active recipient records from the local database. It provides details about delivery preferences, contact information, and localization settings for each recipient. The block is primarily used in interfaces where recipient data is required for personalization or content distribution logic.

General Info #

Name	GetRecipientsLocalDB
Block Category	Interface
Block Types	Local Database
Output Type	Values
Public Block	True
Editable	True

Dependencies #

None

Definition #

SELECT 
    ID,
    PersonID,
    CASE WHEN IsOnlineDeliveryEnabled='0' THEN 'false' ELSE 'true' END AS IsOnlineDeliveryEnabled,
    CASE WHEN IsEmailDeliveryEnabled='0' THEN 'false' ELSE 'true' END AS IsEmailDeliveryEnabled,
    CASE WHEN IsMailDeliveryEnabled='0' THEN 'false' ELSE 'true' END AS IsMailDeliveryEnabled,
    MCopies,
    QCopies,
    Code,
    ReportingCurrency,
    [Language],
    CASE WHEN IsActive='0' THEN 'false' ELSE 'true' END AS IsActive,
    DataUploadId,
    EffectiveDate,
    EmailTO,
    EmailCC,
    EmailBCC,
    IsDummy,
    null AS Person,
    null AS RecipientAccountAssociations,
    EmailTo AS Email
FROM Recipients 
WHERE IsActive = 1

Parameters #

• Input Parameters: None
  This block does not accept any input parameters. It retrieves all active records from the Recipients table.

Output Fields #

Field	Type	Description
ID	Integer	Unique identifier of the recipient record.
PersonID	Integer	Reference to the associated person.
IsOnlineDeliveryEnabled	String	"true" or "false" based on the online delivery preference.
IsEmailDeliveryEnabled	String	"true" or "false" based on the email delivery preference.
IsMailDeliveryEnabled	String	"true" or "false" based on the mail delivery preference.
MCopies	Integer	Number of mail copies.
QCopies	Integer	Number of quarterly copies.
Code	String	Identifier code, usually the recipient’s name.
ReportingCurrency	String	Currency used in reporting, if applicable.
Language	String	Language preference in standard locale format (e.g., en-US).
IsActive	String	"true" if the recipient is active, "false" otherwise.
DataUploadId	Integer	Identifier for the associated data upload batch.
EffectiveDate	Date	Effective date for recipient settings, if provided.
EmailTO	String	Primary email address.
EmailCC	String	Email addresses for carbon copy recipients.
EmailBCC	String	Email addresses for blind carbon copy recipients.
IsDummy	Boolean	Indicator if the record is a dummy entry.
Person	Null	Reserved for future use. Always returns null.
RecipientAccountAssociations	Null	Reserved for future use. Always returns null.
Email	String	Alias for EmailTO, included for convenience.

Example Request #

{}

Example Response #

{
  "data": [
    {
      "ID": 19,
      "PersonID": 27,
      "IsOnlineDeliveryEnabled": "false",
      "IsEmailDeliveryEnabled": "false",
      "IsMailDeliveryEnabled": "false",
      "MCopies": 0,
      "QCopies": 0,
      "Code": "jonny test",
      "ReportingCurrency": USD,
      "Language": "en-US",
      "IsActive": "true",
      "DataUploadId": 11,
      "EffectiveDate": null,
      "EmailTO": "jonny.test@assette.com",
      "EmailCC": "",
      "EmailBCC": "",
      "IsDummy": null,
      "Person": null,
      "RecipientAccountAssociations": null,
      "Email": "jonny.test@assette.com"
    },
    ...
  ],
  "errors": [],
  "success": true,
  "logs": [],
  "sources": []
}

Notes #

• The block enforces a filter on IsActive = 1 to ensure only active recipients are returned.
• Boolean delivery fields are explicitly converted to string values "true" or "false" to support frontend handling.