FidelityMember

Main object of the data model (it stores customer entries), it can have additional criteria, extenalIds and children.

• 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 (see faq entry on idExternal), can be null (i.e. not specified) but not the empty string (aka "")

  127 characters max

• uniqueId

  universal unique identifier

  Alpha (read only)

  64 characters max

• actif

  The status of the member.

  integer

  actif = 0 (DISABLED)
  1 (ENABLED)
  2 (BLOCKED)
  3 (Waiting for password redefinition), -1 (ANONYMYZATION), -99 (ready for deletion)
  ...

• type

  type

  P or C (for Prospect or Client)

  127 characters max

• qualified

  The qualification status of the member.

  boolean

  true if the member has been qualified, false else (default)

• qualificationDate

  The qualification date of the member.

  datetime

  Date of the switch to qualified state of the member

• wallet

  0 = no wallet enabled, 1 = Android wallet installed, 2 = Apple wallet installed. Value managed by the platform in case of wallet integration.

  number

• src

  free text value to indicate the source of the data (default is C for creation)

  Alpha

  25 characters max

• dateCreate

  creation date of this object

  datetime

• dateUpdate

  when was the last update of this object

  datetime

• gender

  The gender of the member

  M, MME, MELLE, COMPANY, COUPLE

  30 characters max

• name

  Alpha

  255 characters max

• secondName

  can be used for middle initial or second name

  Alpha

  255 characters max

• firstname

  Alpha

  255 characters max

• maritalState

  indicates whether the person is married or single

  Alpha

  30 characters max

• image

  URL image

  Alpha

  255 characters max

• uid

  rfid card number

  Alpha (see information about usage of cardnumber / uid for cards Cards)

  64 characters max

• cardnumber

  card number

  Alpha (see information about usage of cardnumber / uid for cards Cards)

  64 characters max

• previousCardnumber

  former card number (e.g. when the card was remove)

  Alpha

  64 characters max

• fidProgramCode

  program level

  Alpha

  255 characters max

• dateRenew

  is valid until this date (dependant of the program)

  datetime

• login

  choosen identifier, can be used for as a sign-in identifier

  Alpha

  64 characters max

• password

  BEWARE the password is a sensitive information, and it is not returned by the API anymore. But you can use this field to set a new password.

• email

  according to rfc

  255 characters max

• tel

  primary phone line

  according to E164 from ITU

  30 characters max

• tel2

  secondary telephone number (e.g. work phone line)

  according to E164 from ITU

  30 characters max

• mobile

  Mobile phone number

  according to E164 from ITU

  30 characters max

• website

  personal homepage url

  according to rfc

  255 characters max

• address

  see Address

• emailOptinStatus

  Status showing the customer approval to receive emails

  integer

  0 (REFUSED)
  1 (ACCEPTED)
  3 (Waiting for customer approval)

• emailoptin

  DEPRECATED
  Use emailOptinStatus instead.

  boolean

  false if the status is 0, true otherwise.

• smsOptinStatus

  Status showing the customer approval to receive SMS

  integer

  0 (REFUSED)
  1 (ACCEPTED)
  3 (Waiting for customer approval)

• smsoptin

  DEPRECATED
  Use smsOptinStatus instead.

  boolean

  false if the status is 0, true otherwise.

• mailOptinStatus

  Status showing the customer approval to receive mails

  integer

  0 (REFUSED)
  1 (ACCEPTED)
  3 (Waiting for customer approval)

• mailoptin

  DEPRECATED
  Use mailOptinStatus instead.

  boolean

  false if the status is 0, true otherwise.

• telOptinStatus

  Status showing the customer approval to receive phone calls

  integer

  0 (REFUSED)
  1 (ACCEPTED)
  3 (Waiting for customer approval)

• teloptin

  DEPRECATED
  Use telOptinStatus instead.

  boolean

  false if the status is 0, true otherwise.

• partnerOptinStatus

  Status showing the customer approval to share his info to your partners

  integer

  0 (REFUSED)
  1 (ACCEPTED)
  3 (Waiting for customer approval)

• partneroptin

  DEPRECATED
  Use mailOptinStatus instead.

  boolean

  false if the status is 0, true otherwise.

• defaultLanguage

  language of the member

  2 chars ISO code

  2 characters max

• birthday

  yo mama's proud of this day (sorry for the joke)

  date (hours, minutes and seconds will be ignored)

• job

  Job class (one of the 8 insee class)

  Alpha

  30 characters max

• criteria

  10 additional fields

  See below

• group

  Who "owns" this member (where was it created)

  see Group

• company

  a FidelityMember whith gender=COMPANY, where do he/she work

  FidelityMember

• sponsor

  the sponsor member og this one

  FidelityMember

• sponsored

  Once this customer have a sponsor, this boolean is set to true and should remained unchanged

  boolean

  true / false

• nbPoint

  current point counter value

  integer

• cumulPoint

  overall sum of the point counter

  integer

• nbCredit

  current credit counter value

  double

• cumulCredit

  overall sum of the point counter

  double

• montantCA

  current amount spent

  double

• cumulCA

  overall amount spent

  double

• dateBill

  date of first addXXX event

  datetime

• dateLastPositiveEvent

  date of last positive event (as defined in parameter : positiveEventType)

  datetime

Criteria

Depending on your customization, a Member may have additionnal information. This information is stored in criteria, there is 10 numeric and 10 alphanumeric criteria available

• cc1

  Any data that do not fit in the std fields

  alpha

  255 characters max

• cc2

  alpha

  255 characters max

• cc3

  alpha

  255 characters max

• cc4

  alpha

  255 characters max

• cc5

  alpha

  255 characters max

• cc6

  alpha

  255 characters max

• cc7

  alpha

  255 characters max

• cc8

  alpha

  255 characters max

• cc9

  alpha

  255 characters max

• cc10

  alpha

  255 characters max

• cc11

  alpha

  255 characters max

• cc12

  alpha

  255 characters max

• cc13

  alpha

  255 characters max

• cc14

  alpha

  255 characters max

• cc15

  alpha

  255 characters max

• cn1

  numeric field, used also for int, boolean

  double

• cn2

  double

• cn3

  double

• cn4

  double

• cn5

  double

• cn6

  double

• cn7

  double

• cn8

  double

• cn9

  double

• cn10

  double

• cn11

  double

• cn12

  double

• cn13

  double

• cn14

  double

• cn15

  double

• cd1

  Date field

  date

• cd2

  date

• cd3

  date

• cd4

  date

• cd5

  date

• cd6

  date

• cd7

  date

• cd8

  date

• cd9

  date

• cd10

  date

• cd11

  date

• cd12

  date

• cd13

  date

• cd14

  date

• cd15

  date

IdExternal

In some cases, a member should be referenced by several external systems. In that case, we recommand to use "idexternals" field instead of "idexternal" field in order to be able to declare several idexternal on one member. "idexternals" is a collection of IdExternal object. See below :

• 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

• group

  see Group

• idexternal

  alpha

  127 characters max

• member

  Which member "owns" this IdExternal

  see FidelityMember

FidelityMemberChild

Children have a dedicated data structure, this avoid storing them as standard FidelityMember and targeting them in campaigns

• 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

• group

  see Group

• idexternal

  alpha

  127 characters max

• dateCreate

  creation date of this object

  datetime

• dateUpdate

  when was the last update of this object

  datetime

• actif

  The status of the child.

  actif = 0 (DISABLED)
  actif = 1 (ENABLED)

• sex

  The gender of the child

  M or F

• name

  Alpha

  255 characters max

• firstname

  Alpha

  255 characters max

• birthday

  mama's proud of this day (sorry for the joke - again)

  date

• age

  is computed based on birthday unless birthday is not fullfilled

  integer

• parent

  Which member "owns" this child

  see FidelityMember

{
  IdExternal:{
    "member":{
      "id":"ADELYA_ID"
    }
  }
}

{
  IdExternal:{
    "member":{
      "idExternals":{
        "idExternal":"SystemX:idexternal"
      }
    }
  }
}