diff --git a/spec/014_notification_api_extension.md b/spec/014_notification_api_extension.md new file mode 100644 index 0000000..63e7a39 --- /dev/null +++ b/spec/014_notification_api_extension.md @@ -0,0 +1,41 @@ +# API EXTENSIONS FOR VIEWING NOTIFICATION DATABASE + + +## NOMENCLATURE + +Values enclosed with `<>` are _required_. + +Values enclosed with `[]` means _optional_. + +No enclosure means _literal_. + +## ADDED METHODS + +Endpoints _added_ are found under /api/ext/ + +### `/api/ext/sms/` `/api/ext/sms/user//` `/api/ext/sms//` + +#### **GET** + +Returns a list of latest sms notifications sent by the platform. + +If `user_id` or `phone_number` is given, only entries for the affected user will be returned. + +Accepts one query string: + +``` + limit: [uint] - maximum items to return (default: 100) +``` + +Response payload: + +``` +[ + { + datetime: , + number: , + message: , + }, + ... +] +```