Reminder related items

Hi Mike,

The reminder related metadata are stored and queried apart from package JSON:

GET /api/packages/{packageId}/reminders

{
  "packageId": "ebfcf18f-7bbc-4ff6-a5db-6352dbbfa9f6",
  "startInDaysDelay": 2,
  "repetitionsCount": 5,
  "intervalInDays": 2,
  "reminders": [
    {
      "sentDate": "2016-02-26T00:30:02Z",
      "date": "2016-02-25T16:53:13Z"
    },
    {
      "sentDate": "2016-02-27T00:30:03Z",
      "date": "2016-02-26T16:53:13Z"
    },
    ......
  ]
}

So for your questions:

a) What is data element internal to package that controls whether reminding is be set?

When you invoke this GET request, if the response is 204 no content, then the package didn't turn on reminders

e) Are reminder fields left out of Package data if "reminder" functionality is not set on?

You always need a second call to determine if reminder has been set up

b) What is data element internal to package that specifies # of days to wait until sending reminder?

"startInDaysDelay" means how many days the initial/first reminder will be sent out

c) What is data element internal to package that specifies # times reminder s/b repeated?

"intervalInDays" means after the initial reminder, how many days the repeated reminders will be sent

"repetitionsCount" means after the initial reminder, how many time the reminders will be repeatedly sent

For example "startInDaysDelay" : 10, "intervalInDays": 3, "repetitionsCount": 2 means, the first reminder will be sent 10 days after, second reminder will be sent 13 days after, and the third reminder will be sent 16 days after, total of 3 reminders

d) Is it correct that only a Sender with "Manager" level can send reminders?

All senders can set up package reminders

Duo

Hi Duo, how do I interpret the 4 dates below for Reminders?

"reminders": [

    {
      "sentDate": "2016-02-26T00:30:02Z",
      "date": "2016-02-25T16:53:13Z"
    },
    {
      "sentDate": "2016-02-27T00:30:03Z",
      "date": "2016-02-26T16:53:13Z"
    },
    ......
  ]

Hi Mike,

The "date" is the scheduled time a reminder will be sent out and the "sentDate" refers to the actual sent date. Because the reminders are sent in batch (every 30 minutes, which could vary in different versions), and the system may fail to clear the queue and accumulates multiple reminders to be sent in the same day, there could be an offset between these two dates.

Duo

But there are still two (sets) of dates, are they both reminder dates? (different dates?) or is one date (set) for one reason and other date (set) for other reason, if so what are the reasons?

The nodes in the array are different reminders in time order. Still taking this example when

"startInDaysDelay" : 10, "intervalInDays": 3, "repetitionsCount": 2 

the first reminder will be sent 10 days after, second reminder will be sent 13 days after, and the third reminder will be sent 16 days after

Total of 3 reminder nodes will be listed in the array, with scheduled "date" field filled in. The "sentDate" field will be null before the reminder actually get sent.

Duo