Create Schema

POST

/policy/create

This endpoint enables the establishment of rules governing medical aid packages,
offering additional context regarding eligible claims within the package. Note you must provide a unique policy_id
to create a new schema, using an already existing one will return an error.

policy_id creation rules

Must not contain any special characters except for _

Must not start with character _

Must be in lowercase

Users can define specific criteria, restrictions, and allowances for claims, ensuring adherence to
policy guidelines and facilitating efficient processing of medical claims within the package.
This endpoint empowers administrators to configure comprehensive schemas tailored to the requirements
and coverage scope of
each medical aid package, enhancing clarity, transparency, and compliance in claim processing.

Request

Body Params application/json

Example

{
    "policy_id": "string",
    "policy_name": "string",
    "grades": [
        "A"
    ],
    "annual_limit": 0,
    "limits": {
        "hospitalization": 0,
        "pathology": 0,
        "radiology": 0,
        "physiotherapy": 0,
        "dental": 0,
        "optical": 0,
        "drugs": 0,
        "anesthetic": 0,
        "consultation": 0,
        "gynaecology": 0,
        "maternity": 0,
        "hearing_aids": 0
    },
    "rules": [
        "string"
    ],
    "currency": "ZiG"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/policy/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "policy_id": "string",
    "policy_name": "string",
    "grades": [
        "A"
    ],
    "annual_limit": 0,
    "limits": {
        "hospitalization": 0,
        "pathology": 0,
        "radiology": 0,
        "physiotherapy": 0,
        "dental": 0,
        "optical": 0,
        "drugs": 0,
        "anesthetic": 0,
        "consultation": 0,
        "gynaecology": 0,
        "maternity": 0,
        "hearing_aids": 0
    },
    "rules": [
        "string"
    ],
    "currency": "ZiG"
}'

Responses

🟢200OK

application/json

Successful Response

Body

Example

null

🟠422Parameter Error

Modified at 2024-12-07 17:10:47

Get All Schema

Update Policy