Eska Medical APIs 4

ESKA – Medical Documentation
ESK/InS-JOR-24:0024 X
Prepared By
Proprietary and Confidential
Copyright 2024 by ESKADENIA Software

All Rights Reserved.
Copyright © 2024 ESKADENIA Software ESKA-Medical 1-25

Table of Contents
1 Quick Price............................................................................................... 6
1.1 GET ALL DEFINED PARAMETERS ........................................................................................ 6
1.2 GET THE PARAMETER VALUES BASED ON THE PARAMETER ID ................................... 6
1.3 LOAD CLASS BENEFITS ....................................................................................................... 7
1.4 LOAD NETWORK.................................................................................................................... 7
1.5 LOAD NETWORK Providers .................................................................................................. 8
2 Insert Policy ............................................................................................. 8
2.1 GET CHANNEL TYPES .......................................................................................................... 9
2.2 LOAD PLANS ........................................................................................................................ 10
2.3 LOAD PAYMENT CYCLES ................................................................................................... 10
3 Insert Members ...................................................................................... 11
3.1 LOAD PLAN CLASSES......................................................................................................... 14
3.2 LOAD BY MAJOR CODE ................................................................................................................ 14
4 MDF ........................................................................................................ 15
5 MDF Answers......................................................................................... 16
6 Insert Policy Agent ................................................................................ 17
6.1 LOAD OFFICES ..................................................................................................................... 17
7 Convert Quotation to Policy ................................................................. 18
8 Calculate ................................................................................................ 19
9 Post ........................................................................................................ 20
10 Renewal Search ..................................................................................... 21
11 Renewal .................................................................................................. 22

Document History
Version Date Summary of Changes Created By Department
0.1 30-04-2024 First Draft Roaa Al-Oglah ESKA/Insurance

1.0 16-07-2024 Update the APIs URL & Roaa Al-Oglah ESKA/Insurance
add the parameter name
for each API
2.0 22-07-2024 Add new API (1.5 load Roaa Al-Oglah ESKA/Insurance
network Providers)
3.0 04-09-2024 -Added new APIs (12 Roaa Al-Oglah ESKA/Insurance

Get Discounts/Loading)
with details.
-New API to apply
discount to specific
policy.
- Policy type values to
be API instead of
Lookup table
4.0 22-09-2024 Added new APIs for the Roaa Al-Oglah ESKA/Insurance
endorsements
5.0 26-09-2024 Added new APIs to Roaa Al-Oglah ESKA/Insurance

remove/update
members & get agent
commissions.
6.0 08-10-2024 Gross Premium has Roaa Al-Oglah ESKA/Insurance
been added to the Add
document API.
Added new API (Add
Member Premium).
Calculate API: the flag
should be 1 in case of
manual Premium.
7.0 13-10-2024 New API to get the Roaa Al-Oglah ESKA/Insurance
mapping for the
parameter values

INTRODUCTION
The Medical Insurance APIs are developed to meet the needs of the customer requirements
as well as the general purpose of the application. These APIs could be used to manipulate
data on ESKADENIA medical insurance system from third party, this document will provide a
description related to production APIs.

Service Authentication
Description
This API is used to generate an authenticated key, which will then be included in the request
header for each API by passing the following parameters:
• Username (required)
• Password (required)
• BranchID (optional)
• CompanyID (optional)
Type
POST
API URL: {{}}// coreintegration/api/logIn/login

1 QUICK PRICE
Description
This API is used to calculate the premium per total number of members according to set of
values.
Type
POST
Request Parameters
Name/parameter name Required/Optional Default value Description

Class ID(ClassId) Required Refer to API #3.1 Represent the class ID
Total No Of Members Required The total number of members

(TotalNoOfMembers)
ParamValues Required Refer to APIs #1.2 Array of parameter values
(ParamValues)
API URL: http://{}/bookrating/api/BrMatrix/QuickPrice
1.1 Get all defined parameters
API URL: http:// {}/setup/api/MstUwParams
1.2 Get the parameter values based on the parameter id
API URL: http://{}/setup/api/MstUwParamValues/GetByCriteria?ParamId=164&PageSize=10&PageNumber=1

1.3 Load Class Benefits
Description
This API is used to get the class benefits.
Type
GET
Request Parameters
Name/parameter Required/Optional Default value Description

name
Class ID Required Refer to API #2.1 Represent the class ID
(ClassId)
API URL: http://{}/setup/api/MstClassBenefits/GetByCriteria?ClassId=1
1.4 Load Network
Description
This API is used to retrieve all defined networks.
Type
GET
API URL:http://{}/network/api/MntNetwork/GetByCriteria?pageSize=5&pageNumber=1

1.5 Load Network providers
Description
This API is used to retrieve all defined providers under specific network.
Type
GET
API URL: http://{}/network/api/MntProvider/GetByCriteria
Request Parameters

name
Network ID Required Refer to API #1.4 Represent the Network ID
(networkId)
pageNumber Required Page Number
branchId Required Branch ID
pageSize Required Page Size
companyId Required Company ID
existsOnNetwork Required true

2 INSERT POLICY
Description
This API is used to insert the policy header.
Type
POST
Request Parameters

name
Company ID Required 1 This is the company ID value
(CompnayId)
Branch Required 1 Lookup table / the correct values
(BranchId) will be provided after the
deployment is complete.
Policyholder Required Please refer to the This is the Customer id
Financial APIs Document
(PolicyHolderId)
Channel Type Required Refer to API #2.1 Represents from where the
(ChannelTypeId) policy has been brought.
Direct “if the policy was brought
to the company directly or the
insurance company itself”
Agent ,Broker and Salesman “if
the policy was brought by
different agency channels”
TPA Type Required 1 Indicates if the policy is
(TpaType) administrated in house or by
Please refer to Lookup TPA.
table section below. “Local Administration” represents
that the policy will be
administrated by insurance
company itself
“TPA” the policy will be
administrated by a third party
“Partially TPA”: part of the policy
will be administrated by the
insurance company itself, and the
other part will be administrated
by a third part.
Lookup table (TPA Type)

Issue Date Required Policy issue date
(IssueDate)
Inception Date Required Same as Policy issue date
(InceptionDate)
Duration(Duration) Required Policy duration
Duration unit Required Please refer to Lookup Lookup table (Duration unit)
(DurationUnit) table section below.
Policy Type Required Group “which could be a

(PolicyType) Refer to API #2.4 company or an institution” ,
Retail “which could be a family
or individual member”
Lookup table(Policy Type)
Plan ID Required Refer to API #2.2 Represents the plan ID which
(PlanId) should be linked with the policy
based on the policy type
Payment Cycle Required Refer to API #2.3 Represents the payment cycle
(PaymentCycleId)
Calculation Type Required 1 Lookup table (Calculation Type)
(CalculationType)
Accounted For Required Please refer to Lookup table (Accounted For)
(AccountedFor) Lookup
table section below.
CUSTOMER ID Required Please refer to the Refer to the Eska Financial APIs
Financial APIs
(PolicyHolderId) Document documentation
Customer name Required Please refer to the Refer to the Eska Financial APIs
Financial APIs
(CustomerName) Document documentation
Customer ACCOUNT Required Please refer to the Refer to the Eska Financial APIs
Financial APIs
(CustomerAccount) Document documentation
Currency Required SAR Lookup table / the correct values
(CurrencyCode) will be provided after the
Ex-rate Required 1
(Exrate)
Document Type Required 1 Lookup table (Document Type)
(DocumentType)
Creation Date Required Current system date
(CreationDate)
Creation User Required AP or CP
(CreationUser)
Endorsment Type Required 21 Lookup table (Endorsment Type)
(EndorsmentType)
GrossPremium optional
(GrossPremium)
API URL: http://{}/underwriting/api/MpdDocuments/add
2.1 Get Channel Types
API URL:
http://{}/sharedsetup/api/SstBusinessChannels/GetByCriteriaINT?CompanyId=1&systemId=337
Type
GET

2.2 Load Plans
API URL: http://{}/setup/api/MstPlans/GetByCriteria?PolicyType=2&CompanyId=1&pageSize=10&

pageNumber=1
2.3 Load Payment Cycles
API URL: http://{}/sharedsetup/api/SstPaymentCycles/GetByCriteriaINT?CompanyId=1&systemId=337
2.4 Policy type
API URL: http:// {}/sharedsetupapi/api/SstPolicyTypes/GetByCriteria?SystemId=337

3 INSERT MEMBERS
Description
This API is used to insert member in specific policy.
Type
POST
Request Parameters

name
Class ID Required Refer to API #3.1 Represent the member class
(ClassId) “ID” which is linked with the
selected policy plan.
Policy ID Required This is the policy ID to associate

(DocumentId) the member with.
Effective Date Required Policy start Date

(EffectiveDate)
Relation Required The Relation for the member

(Relation)
Parent member id Required in case of Eska member ID
(MemberId) the relation is not self
DOB Required Represents member birth date

(BirthDate)
Name Required Represents member name
(Name)
Name2 Optional Represents Member name in
(Name2) Arabic
Country Required Lookup table / the correct values

(Country) will be provided after the
Age Required Represents member age
(Age)
Gender Required Please refer to Represents member gender
(Gender) Lookup table section Lookup table (Gender)
below.
Marital Required Please refer to Represents member marital
status(MaritalStatus) Lookup table section status
below. Lookup table (Marital Status)

Original member id Required only for Eska member id
(OriginalMemberId) correction/
cancellation
endorsements
Creation by Required Current system date
(CreationUser)
Creation Date Required AP or CP
(CreationDate)
Resident Country Optional Lookup table / the correct values
(ResidentCountry) will be provided after the
Resident City Optional Lookup table / the correct values

(ResidentCity) will be provided after the
Reference no Optional Unique number generated in
(ReferenceNo) Neutrinos platform
Notes Optional Remarks

(Notes)
Passport no Optional Represents member Passport no
(PassportNo)
Occupation Optional Refer to API #3.2 Major code : 11
(Occupation)
Phone no Optional Represents member Phone no
(PhoneNo)
Mobile Optional Represents member mobile no
(Mobile)
Height Optional Represents member height
(Height)
Weight Optional Represents member weight
(Weight)
Social no Optional Represents member Social no
(SocialNo)
Staff no Optional Represents member Staff no
(StaffNo)
Member type Optional Please refer to Represents Member type
(MemberType) Lookup table section Lookup table (Member type)
below.
Identity issue place Optional Represents member Identity
(IdentityIssuePlac issue place
e)
Identity expiry date Optional Represents member Identity
(IdentityExpiryDat expiry date
e)
Visa issue place Optional Represents member Visa issue
(VisaIssuePlace) place
File number Optional Represents member File number
(FileNumber)
Salary Optional Refer to API #3.2 Major code : 12
(Salary)
Work location Optional Refer to API #3.2 Major code : 21
(WorkLocation)

Personal email Optional Represents member Personal
(PersonalEmail) email
GDRFA member id Optional Represents member GDRFA ID
(GdrfaMemberId)
New born Optional Represents member new
Certificate born certificate
(NewBornCert
ificate)
No of forms Optional Represents member No of forms

(NoOfForms)
Sponsor name Optional Represents member Sponsor
(SponserName) name
Sponsor no Optional Represents member Sponsor no
(SponserNo)
Cancellation reason Required in case of Refer to API #3.2 Major code : 13
(CancellationReaso member cancellation
n endorsement
Additional no Optional Represents Additional no
(AdditionalNo)
Modification user Optional
Postal code Optional Represents member postal code
(PostalCode)
Address Optional Represents member address
(Address)
Previously insured Optional Please refer to Lookup table (Previously
(PreviouslyInsured Lookup table section insured)
) below.
Fine amount Optional Represents member fine
(FineAmount) amount
District Optional Represents member district
(District)
National id Optional Represents member national id
(NationalId)
Identity type Optional Please refer to Lookup table (Identity type)
(IdentityType) Lookup table section
below.
Building no Optional Represents member national id
(BuildingNo)
Street name Optional Represents member national id
(StreetName)
Used claim per Optional Represents member national id
(UsedClaimPer)
Declarations Optional Represents member national id
(Declarations)
Modification date Optional
Cancelled flag Required in case of Flag (0/1)
(CanceledFlag) member cancellation
endorsement
Is VIP Optional Represents member is VIP or not

(IsVip) (0/1)
Member Optional Elite, Gold, & Silver
Classification
(Classification)

K/InS-JOR-24:0024 X
Occupation Required Refer to API #3.2 Major code : 11
(Occupation)
API URL: http://{}/underwriting/api/MpdDocumentMembers/add
3.1 Load Plan classes
API URL:
http://{}/setup/api/MstClasses/GetByCriteria?PlanId=1&pageNumber=1&pageSize=5&comp
anyId=1
3.2 Load by Major Code
API URL: http://{}/sharedsetup/api/SstCodes/GetByCriteriaINT?CompanyId=1&SystemId=337&MajorCode=14

4 MDF
Description
This API is used to get the Class Survey.
Type
GET
Request Parameters

name
Class ID Required Refer to API #2.1 Represent the class ID
(ClassId)
API URL:
http://{}/setup/api/MstClassQuestionnaires/GetByCriteria?pageIndex=1&pageSize=5&ClassId=1

5 MDF ANSWERS
Description
This API is used to respond to the member survey.
Type
GET
Request Parameters

name
Questionnaire ID Required This is the Question ID from the
(QuestionnaireId) previous step
Answer Required This is the answer value for the
(ANSWER) question
Document Member Required This is the document member ID
ID to link the answer for the
(DocumentMember question for specific member.
Id)
(CreationDate)
(CreationUser)
API URL: http://{}/underwriting/api/MpdDocumentMemberSurvey

6 INSERT POLICY AGENT
Description
This API is used to link the agent with specific policy.
Type
POST
Request Parameters

name
Document ID Required This is the policy id
(documentId)
Agent Type Required Please refer to Lookup table ( Agent Type)
(agentType) Lookup table section
below.
Agent ID Required Please refer to the This is the customer ID
Financial APIs Document
(CustomerId)
Commission % Optional This is the commission
(agentCommPer) Percentage
Commission Optional This is the commission amount
Amount
(amount)
Agent Share Required (100%) in case of one This is the Agent Share
(sharePer) agent
Collection Type Required Please refer to Lookup table (Collection Type)

(collectionType) Lookup table section
below.
Office Optional Refer to API #6.1 Represent the agent office
(officeId)
API URL: http://{}/underwriting/api/MpdDocumentsShares
6.1 Load offices
Sample request:
API URL: {{ }}/sharedsetup/api/SstOffices/GetAll /{CompanyID}

7 CONVERT QUOTATION TO POLICY
Description
This API is used to convert a specific defined quote into a policy.
Type
GET
API URL: http://{}/underwriting/api/MpdDocuments/ConvertToPolicy/280690

8 CALCULATE
Description
This API is used to calculate the member & policy premium.
Type
POST
Request Parameters

name
Document ID Required This is the policy id
(Document ID
)
Username Required This is the User name
(Username)
Is Manual Required 0 1: in case of manual Gross Premium
(isManual)
API URL: http://{}/underwriting/api/MpdDocumentFees/CalculateAmount

9 POST
Description
This API is used to post the policy.
Type
POST
Request Parameters

name
Policy ID Required This is the policy id
(id)
Creation By Required This is the User name

(CreationBy)
Voucher Date Required This is the Voucher Date
(VoucherDate)
Transaction Type Required This is the Transaction Type
(TransactionType)
API URL: http://{}/underwriting/api/VouchersBuilder/PostTransaction

10 RENEWAL SEARCH
Description
This API is used to retrieve all expired policies using search criteria.
Type
GET
Request Parameters
name
Branch Id Optional The ability to search by branch
(branchId) ID
Policy Type Optional The ability to search by Policy
(policyType) Type
Business Channel Optional The ability to search by Business
(businessChannel) Channel
From Expiry Date Optional The ability to search by From
(fromExpiryDate) Expiry Date
To Expiry Date Optional The ability to search by To Expiry
(toExpiryDate) Date
Agent Optional The ability to search by Agent ID
(agent)
Product Name Optional The ability to search by Product
(productName) Name
Plans Optional The ability to search by Plan ID
(plans)
Policy No Optional The ability to search by Policy No
(policyNo)
Policy Holder Optional The ability to search by Policy
(22sername22der) Holder
Renewal Status Optional The ability to search by Renewal
(renewalStatus) Status
Amount From Optional The ability to search by Amount
(amountFrom) From
Amount To Optional The ability to search by Amount
(amountTo) To
Loss Ratio From Optional The ability to search by Loss
(lossRatioFrom) Ratio From
Loss Ratio To Optional The ability to search by Loss
(lossRatioTo) Ratio To
TPA Optional The ability to search by TPA
(tpa)
Policy Ref No Optional The ability to search by Policy
(policyRefNo) Ref No
Optional The ability to search by
Quotation ID Quotation ID
Company Id Optional The ability to search by
(companyId) Company ID
Page Optional Page Number
Number(pageNumber)
Page Size(pageSize) Optional Page Size
API URL: http://{}/underwriting/api/MpdDocuments/RenewalGetByCriteria

11 RENEWAL
Description
This API is used to renew the expired policies.
Type
POST
Request Parameters

name
Ids Required List of the policies, separated by
(Ids) commas (ESKA IDs)
Action Required Please refer to Lookup table (Action)

(action) Lookup table section
below.
User Required This is the User name
Name(Username)
New Plan Flag Optional 0 Create new plan for policy value
(newPlanFlag) 0 or 1
Copy Member Flag Optional 0 Copy members value 0 or 1
(copyMemberFlag)
Renew To Single Optional 0 Renew to one single quotation 0
Quotation or 1
(RenewToSingleQuot
ation)
Notes Optional
(notes)
New Plan Quotation Optional 0 Create new plan for Quotation
(newPlanQuotation) value 0 or 1
Termination Reason Required in case of This is the Termination Reason
(terminationReason) the action value is
(3,4)
Termination Details Required in case of This is the Termination Details
(terminationDetails) the action value is
(3,4)
API URL: http://{}/underwriting//api/MpdDocuments/ApplyRenewal

12 Get Discounts / Loadings
Description
This API is used to retrieve all loadings or discounts have been defined in the core system.
Type
GET
Request Parameters
Name/parameter Required/Option Default value Description

name al
systemId Required 337 System ID ( Medical insurance)
userName Required User name
Type Required Value (1) For discounts.

Value (2) For Loadings.
pageSize Required 20 Page size
pageNo Required 1 Page number
API URL:
http://10.107.6.104/sharedsetupapi/api/Discount/GetByCriteria?systemId=337&companyId=1&24sername=admin&type=1&page
Size=20&pageNo=1

13 Get Discount/Loading Details
Description
This API is used to retrieve the discount/loading details.
Type
GET
Request Parameters

name al
discountId Required Refer to API #12 The discount ID.
userName Required User name
API URL:
http://10.107.6.104/sharedsetupapi/api/PolicyDiscounts/GetByCriteria?companyId=1&discountId=89&25sername=admin
14 Get Discount/Loading Factors
Description
This API is used to retrieve the factors that can be defined for a specific discount/loading.
Type
GET
Request Parameters

name al
policyDiscountId Required Refer to API #13 The discount details ID.

API URL:
http://10.107.6.104/sharedsetupapi/api/SstDiscountsBusinessFactors/GetByCriteria?companyId=1&policyDiscountId=82
15 Add Discount/Loading
Description
This API is used to add discount/loading on specific policy.
Type
PUT
Request Parameters

name al
creationDate Required Creation Date
creationUser Required Creation User
manualFlag Required 1
type Required Value (1) For discounts.

Value (2) For Loadings.
DocumentId Required Refer to API #2 The Policy ID
discountId Required Refer to API #12 The Discount ID
applyOn Required Value (1) to apply the discount on

specific member.
Value (2) to apply the discount on
the policy.
MemberId Optional / Refer to API #3 Required in case the apply on is
Required (1) / The member ID.
Amount Optional The Loading / Discount amount
roundTo Optional Please refer to

Lookuptable section
below.
Rate Optional The Loading / Discount Rate

API URL: http://10.107.6.104/underwriting/api/MpdDocumentDiscLoad/UpdateRange
16 Insert Endorsement
Description
This API is used to insert the endorsement.
Type
POST
Request Parameters

name
Issue Date Required Policy issue date
(IssueDate)
Inception Date Required Same as Policy issue date
(InceptionDate)
Endorsment Type Required Lookup table (Endorsement Type)
(EndorsmentType)
Document Id Required This is the policy ID to associate
(DocumentId) the Endorsement with.
Creation Date Optional Current system date
(CreationDate)
Creation User Optional AP or CP
(CreationUser)
API URL: http://{}/underwriting/api/MpdDocuments/InsertEndorsement
17 Insert Member (Member Addition)

Description
This API is used to insert member in Member addition endorsement.
Type
POST
Request Parameters

name al
Document ID Required This is the Endorsement ID to
(DocumentId) associate the member with.
(Relation)

Parent member id Required in Eska member ID
(ParentMemberId) case of the
relation is not
self
(BirthDate)
(Name)
(Name2) Arabic

(Age)
below.
Marital status Required Please refer to Represents member marital
(MaritalStatus) Lookup table section status


below.
National id Required Represents member national id

(NationalId)
Start Date Required Represents member start date
(StartDate)
Effective Date Required Represents member start date
(EffectiveDate)
Expiry Date Optional Represents member expiry date
(ExpiryDate)
Customer Id Required Please refer to the Refer to the Eska Financial APIs
Financial APIs
(CustomerId) Document documentation
Mobile Required Represents member mobile no
(Mobile)
Sponsor Id Required Represents member Sponsor Id
(SponserId)
Sponsor Name Required Represents member sponsor
(SponserName) name
Classification
(Classification)

Creation User Required Current system date
(CreationUser)
Creation Date Required AP or CP
(CreationDate)
(IsVip) (0/1)
Segment Code Required segmentCode

(SegmentCode)
Member no Required
(MemberNo)

(Occupation)
API URL: http://{}/underwriting/api/MpdDocumentMembers
18 Insert Member (Member Correction)

Description
This API is used to insert member in Member correction endorsement.
Type
POST
Request Parameters
Same as the request parameters of API 17 , in addition to the following parameters
name
Original member id Required only for Eska member id
(OriginalMemberId) correction/
cancellation
endorsements

19 Insert Member (Member Cancellation)
Description
This API is used to insert member in Member cancellation endorsement.
Type
POST
Request Parameters
Same as the request parameters of API (17&18), in addition to the following parameters
name
Cancelled flag Required Flag (0/1)
(CanceledFlag)
20 Update members
Description
This API is used to update the member before posting the document.
Type
PUT
Request Parameters

name al
id Required This is the member ID that you
need to update it.
Document ID Required This is the document ID
(DocumentId)
(Relation)
Parent member id Required in case Eska member ID
(ParentMemberId) of the relation is
not self
(BirthDate)
(Name)
(Name2) Arabic

(Age)
below.
Marital status Required Please refer to Represents member marital
(MaritalStatus) Lookup table section status


below.
National id Required Represents member national id

(NationalId)
Start Date Required Represents member start date
(StartDate)
Effective Date Required Represents member start date
(EffectiveDate)
Expiry Date Optional Represents member expiry date
(ExpiryDate)
Customer Id Required Please refer to the Refer to the Eska Financial APIs
Financial APIs
(CustomerId) Document documentation
Mobile Required Represents member mobile no
(Mobile)
(Occupation)
Sponsor Id Required Represents member Sponsor Id
(SponserId)
Sponsor Name Required Represents member sponsor
(SponserName) name
Classification
(Classification)

(CreationUser)
(CreationDate)
(IsVip) (0/1)
21 Remove members
Description
This API is used to remove members from a policy that has not been posted.
Type
POST
Request Parameters
name
memberIds Required List of member IDs
Document ID Required This is the document ID

(DocumentId)
API URL: http://{}/underwriting/api/MpdDocumentMembers/RemoveMembers
22 Get Agent Commissions

Description
This API is used to get the agent commissions.

Type
GET
Request Parameters
name
AgentId Optional This is the Agent ID.
(AgentId)
API URL: http://{}/sharedsetupapi/api/SstAgentCommissionTiers/GetCommissionTiersByAgentId?AgentId=4868

23 Get Member Premiums
Description
This API is used to get the member premiums for all members in the document.
Type
GET
Request Parameters
name
documentId required This is the document Id
(documentId)
API URL:
http://{{}} /underwriting/api/MpdDocumentMemberPremiums/GetAllMembersPremiumsByDocumentId?documentId=8391229
24 Get Agents
Description
This API is used to get all agents.

Type
GET
Request Parameters
name
systemId optional This is the system id
(systemId)
companyId required This is the company id
(companyId)
API URL:
http://{{}}/sharedsetupapi/api/SstAgents/GetByCriteria?systemId=337&companyId=1
25 Insert Sponsor
Description
This API is used to insert sponsor.

Type
POST
Request Parameters
name
name required This is the sponsor name
(name)

sponsorNo required This is the sponsor No
(sponsorNo)
registryType required Please refer to Lookup This is the sposnor registry type
(registryType) table sectionbelow Lookup table (Registry Type)
registryNo required This is the sponsor registry no

(registryNo)
mobileNo required This is the sponsor mobile no
(mobileNo)
documentId
required This is the document id
(documentId)

(CreationUser)
(CreationDate)
API URL:
http://{{}}/underwriting/api/MpdDocumentSponsor
26 Add Member Premium

Description
This API is used to insert member premium.

Type
POST
Request Parameters
name
Member Id required This is the member id
(MemberId)
NetPremium optional Member net Premium
(NetPremium)
GrossPremium optional Member Gross Premium
(GrossPremium)

(CreationUser)
(CreationDate)
API URL:
http://{{}}/underwriting/api/MpdDocumentMemberPremiums

27 UW Param Mapping
Description
This API is used to get all mapped params depending on Param Id and Param Value Id.
Type
Get
Request Parameters
name
Param Id optional Refer to 1.1 This is the Param id
(paramId)
Param Value Id optional Refer to 1.2 This is the Param Value id
(paramValueId)
API URL:
http://{{}}/setup/api/MstUwParamMapping/GetByCriteria?paramId=221&paramValueId=403

Lookup tables:
Duration unit
1 Day
2 Week
3 Month
4 Year
TPA Type
1 Local Administration
2 TPA
3 Partially TPA
Calculation Type
1 Prorata
2 Full Premium
3 Short Term
Document Type
1 Policy
2 Endorsement
3 Renewal
4 Quotation
Relation
1 Self
2 Spouse
3 Child
4 Parents
5 Others
Gender
1 Male
2 Female
3 Both

Marital Status
1 Single
2 Married
3 Divorced
4 Widow
5 Others
6 Unmarried
Member type
1 UAE National
2 GCC National
3 Diplomat
4 Expat who is residency is
issued in Dubai
5 Expat who is residency is
issued in Emirates other
than Dubai
6 NewBorn
7 Temporarily for
validation error COVID-
19
Previously insured
1 Yes
2 No
Identity type
1 National ID
2 Visa Number
3 Application ID
Agent type
1 BRM
2 Agent
Collection Type
1 Net Premium
2 Gross Premium
3 Gross premium +
Capitation

Actions
1 Renewed to policy
2 Renewed to Quotation
3 Rejected by company
4 Rejected by policy holder
Accounted For
1 Medical Policyholder
3 Medical Agents
Round To
1 Integer
2 Round to 1 decimal
5 Truncate
6 Ceiling
7 Ceiling to 1 decimal
Endorsement Type
1 Member Addition
2 Member Correction
3 Member Cancellation
8 Policy Cancellation
21 Policy Issue
Registry Type
1 ‫ﺳﺠﻞ ﺗﺠﺎري‬
2 ‫ن‬
‫ﻣﺪي‬
‫ﻗ�ﺪ ي‬

Eska Medical APIs 4

Uploaded by

Copyright:

Available Formats

Eska Medical APIs 4

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Eska Medical APIs 4

Uploaded by

Copyright:

Available Formats

ESKA – Medical Documentation

Proprietary and Confidential

Copyright 2024 by ESKADENIA Software

Copyright © 2024 ESKADENIA Software ESKA-Medical 1-25

Copyright © 2024 ESKADENIA Software ESKA-Medical 2-25

Version Date Summary of Changes Created By Department

0.1 30-04-2024 First Draft Roaa Al-Oglah ESKA/Insurance

3.0 04-09-2024 -Added new APIs (12 Roaa Al-Oglah ESKA/Insurance

5.0 26-09-2024 Added new APIs to Roaa Al-Oglah ESKA/Insurance

Copyright © 2024 ESKADENIA Software ESKA-Medical 3-25

Copyright © 2024 ESKADENIA Software ESKA-Medical 4-25

API URL: {{}}// coreintegration/api/logIn/login

Copyright © 2024 ESKADENIA Software ESKA-Medical 5-25

Name/parameter name Required/Optional Default value Description

Total No Of Members Required The total number of members

API URL: http://{}/bookrating/api/BrMatrix/QuickPrice

1.1 Get all defined parameters

API URL: http:// {}/setup/api/MstUwParams

1.2 Get the parameter values based on the parameter id

API URL: http://{}/setup/api/MstUwParamValues/GetByCriteria?ParamId=164&PageSize=10&PageNumber=1

Copyright © 2024 ESKADENIA Software ESKA-Medical 6-25

This API is used to get the class benefits.

Name/parameter Required/Optional Default value Description

API URL: http://{}/setup/api/MstClassBenefits/GetByCriteria?ClassId=1

1.4 Load Network

This API is used to retrieve all defined networks.

Copyright © 2024 ESKADENIA Software ESKA-Medical 7-25

API URL: http://{}/network/api/MntProvider/GetByCriteria

Name/parameter Required/Optional Default value Description

branchId Required Branch ID

pageSize Required Page Size

companyId Required Company ID

existsOnNetwork Required true

Copyright © 2024 ESKADENIA Software ESKA-Medical 8-25

This API is used to insert the policy header.

Name/parameter Required/Optional Default value Description

Lookup table (TPA Type)

Copyright © 2024 ESKADENIA Software ESKA-Medical 9-25

API URL: http://{}/underwriting/api/MpdDocuments/add

2.1 Get Channel Types

Copyright © 2024 ESKADENIA Software ESKA-Medical 10-25

API URL: http://{}/setup/api/MstPlans/GetByCriteria?PolicyType=2&CompanyId=1&pageSize=10&

2.3 Load Payment Cycles

API URL: http://{}/sharedsetup/api/SstPaymentCycles/GetByCriteriaINT?CompanyId=1&systemId=337

2.4 Policy type

API URL: http:// {}/sharedsetupapi/api/SstPolicyTypes/GetByCriteria?SystemId=337

Copyright © 2024 ESKADENIA Software ESKA-Medical 11-25

This API is used to insert member in specific policy.

Name/parameter Required/Optional Default value Description

Policy ID Required This is the policy ID to associate

Effective Date Required Policy start Date

Relation Required The Relation for the member

DOB Required Represents member birth date

Country Required Lookup table / the correct values

Copyright © 2024 ESKADENIA Software ESKA-Medical 12-25

Resident City Optional Lookup table / the correct values

Notes Optional Remarks

Copyright © 2024 ESKADENIA Software ESKA-Medical 13-25

No of forms Optional Represents member No of forms

Is VIP Optional Represents member is VIP or not