Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleScheduleRecord


ScheduleRecord Element

Data Type

Description

Retrieval Code

Recipient

Integer

ID of recipient of the subscription

getRecipient()

Subject

String

Subscription subject

getSubject()

BodyText

String

Subscription message

getBodyText()

FrequencyTypeCode

String

Subscription frequency. Values include:

  • MINUTES
  • DAILY
  • WEEKLY
  • FORTNIGHTLY
  • MONTHLY
  • QUARTERLY
  • BIANNUAL
  • ANNUAL
  • ENDOFMONTH

getFrequencyTypeCode()

FrequencyCode

String

The name of the month (eg, "JANUARY") for a schedule to run

getFrequencyCode()

FrequencyUnit

Integer

Frequency unit that describes the day of month for a schedule to run: it must be within the allowed values for the chosen month (so, no 31 for February)

getFrequencyUnit()

Format

String

Subscription File Type. Values include:

  • PDF
  • HTML
  • CSV
  • DOC
  • XLS
  • RTF

getFormat()

ConditionList

Array (Condition)

Array of Condition objects that store delivery rules (see 20709467)

getConditionList()

AdvancedTimezoneCode

String

Timezone in which the subscription happens

getAdvancedTimezoneCode()

AdvancedTime

Integer

Local run time for the subscription

getAdvancedTime()


...