Campaign (aka com.adelya.sms.Sms)

• id

  Adelya Internal object ID

  Alphanumeric (even if yet just number are in), it's the table primary key, returned on persist or use for fast look-up

• idExternal

  Your reference

  Alpha

  255 characters max

• type

  SMS (always)

  255 characters max

• messageType

  Message Type

  COUPON, MESSAGE

  15 characters max

• status

  Campaign status

  INACTIVE, DRAFT, ACTIVE, ERROR, BLOCKED

  50 characters max

• Subtype

  Can be DEAL or MOBIKOOP for a deal campaign

  Alpha

  255 characters max

• campaignGroupCode

  Allow logical grouping (e.g. 'newsletter')

  Alpha

  50 characters max

• descr

  A title

  Text

• brief

  A long description

  Text

• image

  Image URL

  URL String

  255 characters max

• image2

  Second Image URL (Optional)

  URL String

  512 characters max

• image3

  Third Image URL (Optional)

  URL String

  512 characters max

• tags

  comma separated list of strings

  255 characters max

• inherit

  Indicate if visible by subgroups

  boolean

  true / false

• fidelOnly

  If the campaign is reserved for members of one of the loyalty programs (default is false)

  boolean

  true / false

• seqOrder

  A sorting index, if needed

  Integer

• dateCreate

• dateValidFrom

• dateValidUntil

• locked

  A locked component cannot be modified

  boolean

  true / false

• archive

  An archived status

  boolean

  true / false

• manager

  Email of the component manager, (e.g. who will recieve notifications)

  email

  255 characters max

• publishable

  Can it be published?(default is false)

  boolean

  true / false

• group

  Who "owns" this component

  see Group

• couponValue

  value of the coupon (see couponUnit)

  double

• couponTime

  If it is a type="coupon", length of the validity in days

  integer

• couponUnit

  "addPoint","addCA",
  "addCredit", "RULE",
  "percent","gift"

  15 characters max

• sendDate

• replyTo

  reply to email address for email campaigns

  Alpha

  255 characters max

• sender

  sender email address for email campaigns, sender text for SMS campaign

  Alpha

  255 characters max for email, 10 characters for SMS

• couponInAllPOS

  Is this coupon available in all subgroups? (default is true)

  boolean

  true / false

• campaignResult

  subobject : see campaignResult

• subject

  email subject

  Alpha

  255 characters max

• shortTextContent

  if sms campaign, contains the sms message

  Text

  160 characters max

• onlyOncePerPeriod

  Time limit if any between 2 sent(default is true)

  boolean

  true / false

• onlyOncePeriod

  if onlyOncePerPeriod is true, this value define the time required between two sent for a given member

  Integer

  0 means, only once ever, if >0 it represents the number of days between two sent for the same member

• datetimeCondition

  Days and hours when this campaign is "runnable"

  regular expression

  255 characters max

• memberConditions

  describe additional condition on the member that must be met for the campaign to apply

  255 characters max

• eventConditions

  If there is an event, describe additional condition on the event that must be met for the campaign to apply

  255 characters max

• eventModifications

  If there is an event, describe which modification must be applied to the event

  255 characters max

• defaultCountry

  Country of target by default (default is FR)

  2 chars ISO code

  2 characters max

• bookable

  Flag to set in case of a deal to set it bookable (and generate a voucher) by a member (default is false)

  boolean

  true/false

• datePublishFrom

  Date from which the deal will appear in customer space (W2S) (default is null)

  date

• datePublishUntil

  Date until which the deal will appear in customer space (W2S) (Default is null)

  date

• onlyOncePeriodUsage

  if not 0, indicates number of days between to voucher use for a member from the same deal

  integer

• nbMaxUsage

  Number max of voucher use for a same member

  integer

• nbMaxResa

  Number max of booking for a same member

  integer

• dateUsageFrom

  Date from which a voucher from this deal can be used (default is null)

  date

• dateUsageUntil

  Date until which a voucher from this deal can be used (default is null)

  date

• couponCode

  Code associated to access to a Deal. A specific parameter must be enabled.

  Alphanumeric + "%"

  15 characters

					
{
  Sms:{
    "id":"113002",
	"type":"SMS",
	"descr":"a dummy campaign",
	"campaignResult" : {
	    "id":"512",
		"campaign":"113002",
		"nbClick":"0",
		"nbDisplayed":"0",
		"nbError":"0",
		"nbIgnored":"0",
		"nbMaxSent":"0",
		"nbRead":"0",
		"nbSendWait":"1",
		"nbSent":"0",
		"nbUnsubscribe":"0",
		"nbUsed":"0"
    }
  }
}