Softmatix API - SM.API Help Page

Authentication

API	Description
POST api/Authentication/ValidateRegisterdUser	Validate registered user and return registered user with token
POST api/Authentication/ValidateBI	Validate BI user and return BI user with token
POST api/Authentication/RecoverBIByEmail	Validate BI user by email (recover password)
GET api/Authentication/FindBIByToken/{id}	Find BI user by reset token
POST api/Authentication/UpdateBIPasswordByToken	Update BI user password
POST api/Authentication/ActivateAccount	Activate account (registered user)
POST api/Authentication/ValidateEmail	Validate registered user by email address and create a password reset request
GET api/Authentication/FindByToken/{id}	Find active registered user
POST api/Authentication/UpdatePassword	Update registered user password
POST api/Authentication/AddRegisteredUser	Add registered user

MemberMedicalAid

API	Description
GET api/MemberMedicalAid/Get/{id}	Find member medical aid
GET api/MemberMedicalAid/GetHistory/{id}	Find member medical aid (history)
GET api/MemberMedicalAid/GetMerged/{id}	Find member medical aid (merged)
POST api/MemberMedicalAid/Add	Add medical aid to member
POST api/MemberMedicalAid/Update	Update member medical aid
POST api/MemberMedicalAid/Delete	Delete member medical aid
GET api/MemberMedicalAid/GetGapCoverByID/{id}	Find member gap cover by ID
GET api/MemberMedicalAid/GetGapCover/{id}	Find member gap cover
POST api/MemberMedicalAid/AddGapCover	Add gap cover to member
POST api/MemberMedicalAid/UpdateGapCover	Update member gap cover
POST api/MemberMedicalAid/DeleteGapCover	Delete member gap cover
GET api/MemberMedicalAid/GetVitality/{id}	Find member vitality
POST api/MemberMedicalAid/AddVitality	Add vitality to member
POST api/MemberMedicalAid/UpdateVitality	Update member vitality
POST api/MemberMedicalAid/DeleteVitality	Delete member vitality
GET api/MemberMedicalAid/GetLifeInsurance/{id}	Find member life insurance
POST api/MemberMedicalAid/AddLifeInsurance	Add life insurance to member
POST api/MemberMedicalAid/UpdateLifeInsurance	Update member life insurance
POST api/MemberMedicalAid/DeleteLifeInsurance	Delete member life insurance
GET api/MemberMedicalAid/GetShortTermInsurance/{id}	Find member short term insurance
POST api/MemberMedicalAid/AddShortTermInsurance	Add short term insurnce to member
POST api/MemberMedicalAid/UpdateShortTermInsurance	Update member short term insurance
POST api/MemberMedicalAid/DeleteShortTermInsurance	Delete member short term insurance

Todo

API	Description
POST api/Todo/FindByDate	Find tasks by date
GET api/Todo/FindByMember/{id}	Find tasks by member
GET api/Todo/FindByRegisteredUser/{id}	Find tasks by registered user
POST api/Todo/FindGenericByDate	Find generic tasks by date (Tasks and Workflows)
GET api/Todo/Get/{id}	Find todo item
POST api/Todo/UpdateCompleteStatus	Update task complete status
POST api/Todo/Add	Add task
POST api/Todo/Update	Update task
POST api/Todo/Delete	Delete todo

Commission

API	Description
POST api/Commission/CreateImportBatch	Create import batch
POST api/Commission/ImportCommission	Import commission transactions
POST api/Commission/ImportCommissionBulk	Import commission transactions
POST api/Commission/Finalise	Finalise transactions
GET api/Commission/FindSummary/{id}	List commission summary
POST api/Commission/PostBatch	Process commission batch

Avatar

API	Description
GET api/Avatar/{id}	Get avatar
GET api/Avatar/Thumbnail/{id}	Get avatar thumbnail
POST api/Avatar/UploadFile	Upload BI user avatar

BIUser

API	Description
GET api/BIUser/FindByEmail/{email}	Find BI user by email address
GET api/BIUser/FindByID/{id}	Find BI user by ID
GET api/BIUser/Find	Find BI users
POST api/BIUser/Add	Update BI user
POST api/BIUser/Update	Update BI user
POST api/BIUser/UpdatePassword	Update BI user password

Lookup

API	Description
GET api/Lookup/MedicalAid	Medical aid list
GET api/Lookup/TestLookup	Test Lookup
GET api/Lookup/MedicalAidOptionByMedicalAid/{id}	Options by medical aid
GET api/Lookup/MedicalAidOption	Medical aid options
GET api/Lookup/Title	Member title list
GET api/Lookup/Employer/{id}	Employer list
GET api/Lookup/ChronicCondition	Chronic conditions list
GET api/Lookup/Relationship	Relationships
GET api/Lookup/Gender	List genders
GET api/Lookup/Language	List languages
GET api/Lookup/GapCoverType	List gap cover types
GET api/Lookup/GapCoverOption/{id}	List gap cover options
GET api/Lookup/MembershipStatus	List membership statuses
GET api/Lookup/Position	List user positions
GET api/Lookup/TaskType	List task types
GET api/Lookup/TaskPriority	List task priority
GET api/Lookup/BIUserAll	List all BI users
GET api/Lookup/BIUser	List BI users
GET api/Lookup/MemberReference/{id}	List member reference
GET api/Lookup/RegisteredUserReference/{id}	List registered user reference
GET api/Lookup/SMSTemplate	List SMS templates
GET api/Lookup/LeadGroup	List lead groups
GET api/Lookup/MemberFollowUpGroup	List member follow up group
GET api/Lookup/ActionStatus	Action status list
GET api/Lookup/SystemRole	Action status list
GET api/Lookup/BrokerGroup	List broker groups
GET api/Lookup/BrokerGroupReport	List broker groups
GET api/Lookup/MemberWorkflowActionType/{id}	List member reference
GET api/Lookup/RequestReceivedFrom	Request received from list
GET api/Lookup/MedicationSupplier	Medication supplier list
GET api/Lookup/MedicalAidPlanType	Medical aid plan type list
GET api/Lookup/ReimbursementRate	Reimbursement rate list
GET api/Lookup/Province	Province list
GET api/Lookup/Bank	Bank list
GET api/Lookup/BankAccountType	Bank account type list
GET api/Lookup/ShortTermInsuranceType	List short term insurance types
GET api/Lookup/LifeInsuranceType	List life insurance types
GET api/Lookup/InsuredType	List life insured types
GET api/Lookup/LifeInsuranceCoverType	List life insurance cover type
GET api/Lookup/MedicalAidOptionAI	List life medical aid options for AI ** Testing Only

MemberDependant

API	Description
GET api/MemberDependant/GetAll/{id}	Find dependants
GET api/MemberDependant/Get/{id}	Find dependant item
POST api/MemberDependant/Update	Update dependant
POST api/MemberDependant/Add	Add dependant
POST api/MemberDependant/Delete	Delete dependant

ExportReport

API	Description
POST api/ExportReport/CommissionReport	Export DevExpress report to PDF

Questionnaire

API	Description
POST api/Questionnaire/AddNeedAnalysis	Add need analysis
POST api/Questionnaire/FindNeedAnalysisByDate	Find need analysis by date range

MemberFollowUp

API	Description
GET api/MemberFollowUp/MemberFollowUpGroupTransaction/{id}/{userId}	Find member follow up group transactions
GET api/MemberFollowUp/FindMemberFollowUpGeneric/{id}	Find member generic follow up
POST api/MemberFollowUp/UpdateGeneric	Update member follow up generic
POST api/MemberFollowUp/UpdateGeneral	Update lead general

Search

API	Description
POST api/Search	Search members
POST api/Search/FindBirthDay	Find member birthdays
POST api/Search/FindMergeMembers	Find merge members

MemberCorrespondence

API	Description
GET api/MemberCorrespondence/GetAll/{id}	Find member correspondence

Lead

API	Description
GET api/Lead/LeadGroupTransaction/{id}	Find lead group transactions
POST api/Lead/Search	Search leads
GET api/Lead/FindLead/{id}	Find lead by id
POST api/Lead/UpdateGeneral	Update lead general

Member

API	Description
GET api/Member/Summary/{id}	Find member summary
GET api/Member/Get/{id}	Find member item
POST api/Member/Add	Add new member
POST api/Member/Update	Update member
POST api/Member/UpdateGeneral	Update member general
GET api/Member/Contributions/{id}	Find member contributions
POST api/Member/ValidateNewMember	Validate new member registration
POST api/Member/PrepareExistingMember	Prepare existing member for update
POST api/Member/UpdateFollowUp	Update member general
POST api/Member/Merge	Update members
POST api/Member/Delete	Delete member
POST api/Member/DependantOver21	Find member dependants over 21 years of age
GET api/Member/BulkSMS	Find bulk SMS

MemberBank

API	Description
GET api/MemberBank/Get/{id}	Find member medical banking details
POST api/MemberBank/Update	Update member banking details

SMSTemplate

API	Description
GET api/SMSTemplate/GetAll/{id}	Find SMS templates
GET api/SMSTemplate/Get/{id}	Find member note item
POST api/SMSTemplate/Update	Update SMS template
POST api/SMSTemplate/Add	Add SMS template
POST api/SMSTemplate/Delete	Delete SMS template

Compare

API	Description
POST api/Compare/CompareOptions	Compare medical aid options
POST api/Compare/CompareOptionsAll	Compare medical aid options including previous year
POST api/Compare/EditCompareOptions	Compare medical aid options (edit function)
POST api/Compare/Update	Update comparison data

OpenAI

API	Description
GET api/OpenAI/LoadDefault/{id}	Init default document data
POST api/OpenAI/Query	Query OpenAI
POST api/OpenAI/CompareOptionsContribution	Compare medical aid options - Contribution

Logging

API	Description
POST api/Logging/LogMailDocDownload	Log mail document download
POST api/Logging/LogDownload	Log mail document download

RegisteredUserNote

API	Description
GET api/RegisteredUserNote/GetAll/{id}	Find notes
GET api/RegisteredUserNote/Get/{id}	Find note item
POST api/RegisteredUserNote/Update	Update note
POST api/RegisteredUserNote/Add	Add note
POST api/RegisteredUserNote/Delete	Delete note

CampaignUser

API	Description
POST api/CampaignUser/Add	Add and validate campaign user
POST api/CampaignUser/LogDownload	Add document download log

SMS

API	Description
POST api/SMS/BulkMemberBirthday	Find bulk member birthday's
POST api/SMS/BulkLogBirthdaySMS	Log sms correspondence (bulk)
POST api/SMS/LogSMS	Log sms correspondence

Workflow

API	Description
GET api/Workflow/Find/{id}	Find workflow
GET api/Workflow/New/{id}/{workflowid}	Return new workflow entity
POST api/Workflow/AddWorkflow	Add member workflow
POST api/Workflow/UpdateWorkflow	Update member workflow
GET api/Workflow/FindByMemberID/{id}	Find tasks by member
POST api/Workflow/FindByDate	Find tasks by date

Discrepancy

API	Description
POST api/Discrepancy	List discrepancies

Dashboard

API	Description
GET api/Dashboard/Summary	Find dashboard sumary

BestmedImport

API	Description
POST api/BestmedImport/Truncate	Delete Bestmed import transactions
POST api/BestmedImport/Import	Import Bestmed client transactions
POST api/BestmedImport/Finalise	Finalise Bestmed import

RegisteredUser

API	Description
GET api/RegisteredUser/FindByID/{id}	Find member by ID
POST api/RegisteredUser/Find	Find registrered users
POST api/RegisteredUser/Update	Update registered user
POST api/RegisteredUser/UpdatePassword	Update registered user
POST api/RegisteredUser/UpdateGeneral	Update lead general
POST api/RegisteredUser/Delete	Delete registeredUser

MailSubscription

API	Description
POST api/MailSubscription/Unsubscribe	General Unsubscribe

MemberNote

API	Description
GET api/MemberNote/GetAll/{id}	Find member notes
GET api/MemberNote/Get/{id}	Find member note item
POST api/MemberNote/Update	Update member note
POST api/MemberNote/Add	Add member note
POST api/MemberNote/Delete	Delete member note