Usherpa Mobile API's Help Page

Task

Tasks

API	Description
GET api/task/CompleteTask/{memberId}?taskId={taskId}	Complete the specified task for the member.
GET api/task/UnCompleteTask/{memberId}?taskId={taskId}	Uncomplete the specified task for the member
GET api/task/DismissTask/{memberId}?taskId={taskId}	Dismiss a task
GET api/task/DismissTask/{memberId}?startDate={startDate}&endDate={endDate}	Dismiss all tasks in a date range
GET api/task/UndismissTask/{memberId}?taskId={taskId}	Undismiss a task
GET api/task/UndismissTask/{memberId}?startDate={startDate}&endDate={endDate}	Undismiss all dismissed tasks in a date range
GET api/task/GetTasks/{memberId}	Get the list of todays tasks for a member.
GET api/task/GetTasks/{memberId}?startDate={startDate}&endDate={endDate}&showDismissed={showDismissed}	Get the list of tasks for a member.

Notification

Alerts

API	Description
POST api/notification/RegisterIOSDevice	Register an IOS device
POST api/notification/RegisterAndroidDevice	Register an Android device
GET api/notification/GetDevice/{memberId}	Get a device for a member
POST api/notification/SignOutDevice?deviceId={deviceId}	Sign out a device.
POST api/notification/ClearNotificationCount?deviceId={deviceId}	Clears the notification count for the given device.

EmailAnalytics

Email Analytics

API	Description
GET api/emailanalytics/GetEmailCounts/{memberId}	Get the email analytics for yesterday for a member.
GET api/emailanalytics/GetEmailCounts/{memberId}?startDate={startDate}&endDate={endDate}&showDismissed={showDismissed}	Get the email analytics for a member.
GET api/emailanalytics/DismissEmailCounts/{memberId}?processEmailid={processEmailid}&date={date}	Dismisses the email analytics for the specified member and date
GET api/emailanalytics/DismissEmailCounts/{memberId}?startDate={startDate}&endDate={endDate}	Dismisses the email analytics for the specified member and dates
GET api/emailanalytics/UndismissEmailCounts/{memberId}?processEmailid={processEmailid}&date={date}	Undismisses the email analytics for the specified member and date
GET api/emailanalytics/UndismissEmailCounts/{memberId}?startDate={startDate}&endDate={endDate}	Undismisses the email analytics for the specified member and dates

Tracking

Tracking

API	Description
GET api/tracking/PhoneCallBirthday/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&date={date}	Tracks a phone call and marks the birthday alert for the specified date as complete
GET api/tracking/PhoneCallLoanCheckup/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&loanId={loanId}&date={date}	Tracks a phone call and marks the loan checkup alert for the specified date as complete
GET api/tracking/PhoneCallTask/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&taskId={taskId}	Tracks a phone call and marks the task as complete
GET api/tracking/EmailBirthday/{memberId}?contactId={contactId}&email={email}&date={date}	Tracks an email sent and marks the birthday alert for the specified date as complete
GET api/tracking/EmailLoanCheckup/{memberId}?contactId={contactId}&email={email}&loanId={loanId}&date={date}	Tracks an email sent and marks the loan checkup alert for the specified date as complete
GET api/tracking/EmailTask/{memberId}?contactId={contactId}&email={email}&taskId={taskId}	Tracks an email sent and marks the task as complete
GET api/tracking/TextBirthday/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&date={date}	Tracks a text and marks the birthday alert for the specified date as complete
GET api/tracking/TextLoanCheckup/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&loanId={loanId}&date={date}	Tracks a text and marks the loan checkup alert for the specified date as complete
GET api/tracking/TextTask/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&taskId={taskId}	Tracks a text and marks the task as complete

TaskV2

Tasks

API	Description
GET v2/GetTasks/{memberId}	Get the list of todays tasks for a member.
GET v2/GetTasks/{memberId}?startDate={startDate}&endDate={endDate}&showDismissed={showDismissed}	Get the list of tasks for a member.
GET v2/CompleteTask/{memberId}?taskId={taskId}&taskType={taskType}	Complete the specified task for the member.
GET v2/UnCompleteTask/{memberId}?taskId={taskId}&taskType={taskType}	Uncomplete the specified task for the member
GET v2/DismissTask/{memberId}?taskId={taskId}&taskType={taskType}	Dismiss a task
GET v2/DismissTask/{memberId}?startDate={startDate}&endDate={endDate}	Dismiss all tasks in a date range
GET v2/UnDismissTask/{memberId}?taskId={taskId}&taskType={taskType}	Undismiss a task
GET v2/UnDismissTask/{memberId}?startDate={startDate}&endDate={endDate}	Undismiss all dismissed tasks in a date range

TrackingV2

Tracking

API	Description
GET v2/PhoneCallTask/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&taskId={taskId}&taskType={taskType}	Tracks a phone call and marks the task as complete
GET v2/EmailTask/{memberId}?contactId={contactId}&email={email}&taskId={taskId}&taskType={taskType}	Tracks an email sent and marks the task as complete
GET v2/TextTask/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&taskId={taskId}&taskType={taskType}	Tracks a text and marks the task as complete
GET v2/PhoneCallOpportunity/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&opportunityId={opportunityId}&opportunityType={opportunityType}	Tracks a phone call for opportunities.
GET v2/EmailOpportunity/{memberId}?contactId={contactId}&email={email}&opportunityId={opportunityId}&opportunityType={opportunityType}	Tracks an email sent for opportunites.
GET v2/TextOpportunity/{memberId}?contactId={contactId}&phoneNumber={phoneNumber}&opportunityId={opportunityId}&opportunityType={opportunityType}	Tracks a text sent for opportunities.

OpportunityV2

Tasks

API	Description
GET v2/GetOpportunities/{memberId}	Get the list of todays opportunity alerts for a member.
GET v2/GetOpportunities/{memberId}?startDate={startDate}&endDate={endDate}&showDismissed={showDismissed}	Get the list of opportunity alerts for a member.
GET v2/CompleteOpportunity/{memberId}?opportunityId={opportunityId}&opportunityType={opportunityType}&dispositionId={dispositionId}	Complete an opportunity
GET v2/UnCompleteOpportunity/{memberId}?opportunityId={opportunityId}&opportunityType={opportunityType}	Uncomplete an opportunity
GET v2/DismissOpportunity/{memberId}?opportunityId={opportunityId}&opportunityType={opportunityType}	Dismiss an opportunity
GET v2/DismissOpportunities/{memberId}?startDate={startDate}&endDate={endDate}	Dismiss all opportunities in a date range
GET v2/UnDismissOpportunity/{memberId}?opportunityId={opportunityId}&opportunityType={opportunityType}	Undismiss an opportunity
GET v2/UnDismissOpportunities/{memberId}?startDate={startDate}&endDate={endDate}	Undismiss all dismissed opportunities in a date range

Alert

Alerts

API	Description
GET api/alert/GetBirthdayAlerts/{memberId}	Get the list of todays birthday for a member.
GET api/alert/GetBirthdayAlerts/{memberId}?startDate={startDate}&endDate={endDate}&showDismissed={showDismissed}	Get the list of birthdays for a member.
GET api/alert/GetLoanCheckupAlerts/{memberId}	Get the list of todays closed loans for a member.
GET api/alert/GetLoanCheckupAlerts/{memberId}?startDate={startDate}&endDate={endDate}&showDismissed={showDismissed}	Get the list of closed loans for a member.
GET api/alert/CompleteBirthdayAlert/{memberId}?contactId={contactId}&date={date}	Completes the birthday alert for the specified date, member and contact
GET api/alert/UncompleteBirthdayAlert/{memberId}?contactId={contactId}&date={date}	Uncompletes the birthday alert for the specified date, member and contact
GET api/alert/DismissBirthdayAlert/{memberId}?contactId={contactId}&date={date}	Dismisses the birthday alert for the specified date, member and contact
GET api/alert/DismissBirthdayAlert/{memberId}?startDate={startDate}&endDate={endDate}	Dismisses the birthday alerts for the specified date range and member
GET api/alert/UndismissBirthdayAlert/{memberId}?contactId={contactId}&date={date}	Undismisses the birthday alert for the specified date, member and contact
GET api/alert/UndismissBirthdayAlert/{memberId}?startDate={startDate}&endDate={endDate}	Undismisses the birthday alerts for the specified date range and member
GET api/alert/CompleteLoanCheckupAlert/{memberId}?loanId={loanId}&date={date}	Completes the Loan Checkup alert for the specified date, member and loan
GET api/alert/UncompleteLoanCheckupAlert/{memberId}?loanId={loanId}&date={date}	Uncompletes the Loan Checkup alert for the specified date, member and loan
GET api/alert/DismissLoanCheckupAlert/{memberId}?loanId={loanId}&date={date}	Dismisses the Loan Checkup alert for the specified date, member and loan
GET api/alert/DismissLoanCheckupAlert/{memberId}?startDate={startDate}&endDate={endDate}	Dismisses the Loan Checkup alert for the specified date, member and loan
GET api/alert/UndismissLoanCheckupAlert/{memberId}?loanId={loanId}&date={date}	Undismisses the Loan Checkup alert for the specified date, member and loan
GET api/alert/UndismissLoanCheckupAlert/{memberId}?startDate={startDate}&endDate={endDate}	Undismisses the Loan Checkup alerts for the specified date range and member