Skip to content

Latest commit

 

History

History
173 lines (150 loc) · 4 KB

NOTIFICATION_PLAN_API.md

File metadata and controls

173 lines (150 loc) · 4 KB
Raw

Notification Plan API

About the Notification Plan

The notfication plan is stored as a JSON array of steps to take when notifying a person. The order of the array is the order in which the steps are followed. An example plan looks like this:

[
    {
        "method": "sms://2108675309",
        "notify_every_period": 0,
        "notify_until_period": 900000000000
    },
        {
        "method": "phone://2105551212",
        "notify_every_period": 0,
        "notify_until_period": 900000000000
    },
    {
        "method": "email://lancelot@roundtable.org.uk",
        "notify_every_period": 300000000000,
        "notify_until_period": 0
    }
]

The fields of a step are as follows:

Field Description
method Method of notification The following are valid examples: phone://2108675309, sms://2105551212, email://lancelot@roundtable.org.uk
notify_every_period Period of time in which to repeat a notification Time is stored in nanoseconds. 1 minute = 60000000000. This is only relevant to the last notification step in the array, since the last step is the only one repeated ad infinitum until the person responds. A 0 value indicates that this step will only be followed once and not repeated. If this field is set for a step that's not the last in the array, it will be ignored.
notify_until_period Period of time in which the service waits for a response before proceeding to the next notification step in the array Time is stored in nanoseconds. 1 minute = 60000000000. A 0 value is not valid for this field and will result in the step being skipped. If this field is set for the very last step in the array, it will be ignored.

Notification Plan API Methods

Get notification plan for a person

Request

GET /plan/USERNAME

Example Response

HTTP/1.1 200 OK

{
  "people": {
    "username": "lancelot",
    "steps": [
      {
        "method": "sms://2108675309",
        "notify_every_period": 0,
        "notify_until_period": 300000000000
      },
      {
        "method": "phone://2105551212",
        "notify_every_period": 900000000000,
        "notify_until_period": 0
      }
    ]
  },
  "message": "",
  "error": ""
}

Create a new notification plan for a person

Request

POST /plan/USERNAME

[
    {
        "method": "sms://2108675309",
        "notify_every_period": 0,
        "notify_until_period": 300000000000
    },
    {
        "method": "phone://2105551212",
        "notify_every_period": 900000000000,
        "notify_until_period": 0
    }
]

Example Response

HTTP/1.1 200 OK

{
  "people": {
    "username": ""
  },
  "message": "Notification plan for user lancelot created",
  "error": ""
}

Update an existing notification plan for a person

Request

Note: The API does not support atomic updates of notification plans. You need to post the entire plan even if you're just updating part of it.

PUT /plan/USERNAME

[
    {
        "method": "phone://2105551212",
        "notify_every_period": 0,
        "notify_until_period": 300000000000
    },
    {
        "method": "sms://2108675309",
        "notify_every_period": 600000000000,
        "notify_until_period": 0
    }
]

Example Response

HTTP/1.1 200 OK

{
  "people": {
    "username": "lancelot",
    "steps": [
      {
        "method": "phone://2105551212",
        "notify_every_period": 0,
        "notify_until_period": 300000000000
      },
      {
        "method": "sms://2108675309",
        "notify_every_period": 600000000000,
        "notify_until_period": 0
      }
    ]
  },
  "message": "Notification plan for user lancelot updated",
  "error": ""
}

Delete a notification plan for a person

Request

DELETE /plan/USERNAME

Example Response

HTTP/1.1 200 OK

{
  "people": {
    "username": ""
  },
  "message": "Notification plan for user lancelot deleted",
  "error": ""
}