GetContactBirthdays

Overview

Get birthdays for an account based on information sent via an http form post.

Post Url

https://hyperdrivepro.morethanrewards.com/api/2/GetContactBirthdays.aspx

- SSL is required

Form Fields

FieldMax Length*RequiredNotes
response_type
Yes

Set this field value to json to return results in JSON format

accountid
YesMust be numeric. Account ID for this account. 
apikey
YesAPI Key for this account. 
month2YesMonth for birthdays  [A number, 1 through 12]
day2YesDay of the month (combined with Month to return all birthdays for that Month/Day)  [A number, 1 through 31]

Notes

  • The field contactindex returned in the results indicates whether the contact is the PRIMARY (1) or SECONDARY (2) contact on the contact record.
  • Depending on the contact record, the birthday field may return just a month/day   01/08  (January 8th)  or a full  month/day/year   01/08/2002  (January 8th, 2002)
  • emailaddress will correlate to the first or secondary contact.  (If it’s the secondary contact’s birthday, their email address will be shown, not the primary email address)

Sample Results

Success Message

<results>
   <contacts>
     <contact>
       <contactid>10001</contactid>
       <contactindex>1</contactindex>
       <firstname>Mary</firstname>
       <lastname>Smith</lastname>
       <email>test@test.com</email>
       <birthday>12/05</birthday>
     </contact>
   </contacts> 
</results>

Sample Failure Message

<?xml version="1.0"?> 
<results>
     <error>Authentication failed</error> 
</results>