Member Indicative Premium

IndicativePremium

GetByCorrelationId

Retrieve a Member's Plan premium details using a unique request tracking identifier

Request

GET /api/IndicativePremium?correlationId

Parameters

Name	In	Type	Default	Notes
*correlationId	query			Unique Identity for mapping/tracking API Gateway http requests

Responses

Status Code	Type	Description	Samples
200	IndicativePremiumResponse	OK
404	string	NotFound

Request

Retrieve a Member's Plan premium details using a member details

Request

POST /api/IndicativePremium

Parameters

Name	In	Type	Default	Notes
*indicativePremiumRequest	body	IndicativePremiumRequest		A modelled object with required properties

Responses

Status Code	Type	Description	Samples
200	string	OK
406	string	NotAcceptable

IndicativePremiumCalculation

Request

Retrieve indicative premium estimation based on input data

Request

POST /api/IndicativePremiumCalculation

Parameters

Name	In	Type	Default	Notes
*request	body	IndicativePremiumCalculationRequest

Responses

Status Code	Type	Description	Samples
200	IndicativePremiumResponse	OK
406	string	NotAcceptable

IndicativePremiumCancellation

Request

Cancel a Indicative Premium Request

Request

GET /api/IndicativePremiumCancellation?correlationId

Parameters

Name	In	Type	Default	Notes
*correlationId	query			Unique Identity for mapping/tracking API Gateway http requests

Responses

Status Code	Type	Description	Samples
200	boolean	OK

IndicativePremiumHealthCheck

HealthCheck

Retrieve indicative premium health check

Request

POST /api/IndicativePremiumHealthCheck

Parameters

Name	In	Type	Default	Notes
*request	body	IndicativePremiumRequest

Responses

Status Code	Type	Description	Samples
200	IndicativePremiumResponse	OK
406	string	NotAcceptable

Definitions

IndicativePremiumResponse

Name	Type	Notes
ReferenceNumber	string	The reference that is used by the Client for request/response map
StatusCode	string	Indicates the status code for the request 997 - Member retrieval successful 998 - No records found with request criteria. 999 - Failed to complete request.
MedicalSchemeName	string	Member's medical scheme name
MedicalSchemePlanName	string	Member's medical plan name
MembershipNumber	string	Member's medical plan membership number
PolicyActive	boolean	Policy active status
Members	IndicativeMember[]	List of covered members
IndicativePremium	number (double)	Member monthly premium amount
RequestDateTime	string (date-time)	Request recieved date and time
ResponseDateTime	string (date-time)	Request postback date and time
Validations	Validation[]	Member request Validations

IndicativeMember

List of covered members

Name	Type	Notes
DependantCode	string	Member dependant code
MemberType	integer (int32)	Member type 1 - MainMember 2 - AdultDependant 3 - ChildDependant 9 - Unknown
MemberTypeDescription	string	Member type text description
IdentificationNumber	string	Member personal identification number
Initials	string	Member initials
FullName	string	Member full names
Surname	string	Member surname
Gender	integer (int32)	Member gender 1 - Male 2 - Female 9 - Unknown
DateOfBirth	string (date-time)	Member date of birth
MemberEffectiveFrom	string (date-time)	Member medical scheme covered from date
MemberTerminationDate	string (date-time)	Member medical scheme covered to date
IndicativeMemberCovered	boolean	Member currently covered or not
Contribution	number (double)	Member monthly contribution amount

Validation

Member request Validations

Name	Type	Notes
Action	integer (int32)	Action type of the validation applied 0 - Info 1 - Route 2 - Reject 9 - Unknown
Key	string	A code representing an applied validation
Message	string	Text describing the applied validation.

IndicativePremiumRequest

Name	Type	Notes
HasGivenConsent	boolean	Consent given for use of the personal identification number search
IdentificationNumber	string	Member identification number to search
GrossIncome	number (double)	Member's gross income amount

IndicativePremiumCalculationRequest

Name	Type	Notes
SchemeGuid	string (uuid)	Scheme Reference Guid
PlanGuid	string (uuid)	Plan Reference Guid
IdentificationNumber	string	Main Member Identification Number
MainMembershipDateOfBirth	string (date-time)	Main Member date of birth
MembershipNumber	string	Membership reference number
GrossIncome	number (double)	Member's gross income amount
Members	IndicativePremiumCalculationRequestMember[]	List of covered members

IndicativePremiumCalculationRequestMember

List of covered members

Name	Type	Notes
Initials	string	Member initials
FullName	string	Member full names
Surname	string	Member surname
DependantCode	string	Member dependant code
MemberType	integer (int32)	Member type 1 - MainMember 2 - AdultDependant 3 - ChildDependant 9 - Unknown
IdentificationNumber	string	Member personal identification number
Gender	integer (int32)	Member gender 1 - Male 2 - Female 9 - Unknown
DateOfBirth	string (date-time)	Member date of birth