Umunhum Client Message Methods

Version 0.1
For Review

Todo:
1. Change Subscriber to patient
2. Change Address book to to list of patients.
3. Add primary contact (aka buddy) to patient profile

Client Methods

Subscriber

Add Subscriber (client id, name, notification method, phone number prefix, cell phone number, email address, medical aid indicator, doctor, diagnosis, address book id, …)

Send Message to Subscriber (client id, subscriber id, schedule definition string, expiration date, message template id, substitute text)

Message Template

Add Message Template (client id, message template string)

Update Message Template (client id, message template id, new message string)

Subscriber Records

Search Subscriber Records (client id, name, name search type, notified by sms indicator, notified by email indicator, phone number prefix, phone number, phone number search type, email address, email address search type, medical aid, medical aid search type, doctor, doctor search type, diagnosis, diagnosis search type, substitute text, medication, medication search type)

Update Subscriber Records (client id, subscriber id, name, notify by sms indicator, notify by email indicator, phone number prefix, phone number, email address, medical aid indicator, doctor, diagnosis, address book id, …)

Address book

Create Address book (client id, address book name)

Move Address Book (client id, from address book id, to address book id)

Copy Address Book (client id, from address book id, to address book id)

Remove Address Book (client id, address book id )

Reports

Get Scheduled Notication Report (client id, schedule period type)

Get Recently Sent Notification Report (client id)

Schedule Delivery of Notification Summary Report (client id , report period type, email address)

Get Available Credits Report (client id )

Send Message (client id, address book id, message)

Logout (client id)

Adminstrator Methods

Login (username, password)

Reports

Summary Status Report (administrator id, client id)

Batch Status Report (administrator id, client id)

Recent Batch Status Reports (administrator id)

Message Files (administrator id, client id, message list id, description, filename)

Client Administration
Add Client (administrator id, client name)

List Client Details (administrator id)

Add Client Preferences (administrator id, client id, pref id, pref value, …)

Client Credit Administration

Add Credit (administrator id, client id)

List Credit Summary (administrator id)

Subscriber Administration

Search for Subscriber (administrator id, name, notification method, cellphone, email, medicalaid, doctor, diagnosis)

Delete Subscriber (administrator id, subscriber id)

Backup (administrator id, backup file name)

Bulk SMS

Send Bulk SMS (administrator id, cell number, message)

Show Build SMS Credits (administrator id, )

Logout (administrator id)