aiM18 Developer Center
  • Web Services
  • Human Capital Management
Multiable
2024-02-29
目录

Medical Claim Management

Version: 1.2 | Release Date: 30/01/2024

# Medical Plan Type

# Fetch Medical Plan Type List

# Description

Usage: Fetch Medical Plan Type List

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/search/search
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    stSearch String (Query) Yes Lookup Type. You can find it in Lookup.
    （Eg: medPlanType ......）
    formatId long (Query) No Lookup Query ID, If not specified, the default format is used.
    startRow int (Query) No Resultset offset : start index
    endRow int (Query) No Resultset offset : end index
    quickSearchStr String (Query) No Quick search keyword

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/search/search";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&stSearch=").append("medPlanType");
    paramStrBuilder.append("&startRow=").append(0);
    paramStrBuilder.append("&endRow=").append(10);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "stSearch": "medPlanType",
    "size": 1,
    "stSearchDisplay": "Medical Plan Type",
    "values": [
        {
            "code": "CW10 test",
            "desc__lang": "",
            "status": "Y",
            "iRev": 4,
            "lastModifyDate": "2020-03-23 18:25:41",
            "medPlanType.lastModifyUid.simpleUser.desc__lang": "admin",
            "id": 27,
            "st_desc": "CW10 test",
            "st_id": 27,
            "st_code": "CW10 test"
        }
    ]
}

# Create Medical Plan Type

# Description

Usage: Create Medical Plan Type

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/save/medPlanType
    HTTP Method PUT
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medPlanType
    entitYes String (Body) Yes JSON (Refer to Request Sample)

  3. Request Sample

    long recordId = 0;

CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/save/medPlanType";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medPlanType");

    HttpPut put = new HttpPut(url + "?" + paramStrBuilder.toString());
    put.addHeader("authorization", access_token);
    put.addHeader("client_id", ClientID);

    StringEntity entity = new StringEntity(data.toJSONString(), ContentType.APPLICATION_JSON);
    entity.setContentEncoding("UTF-8");
    put.setEntity(entity);

    res = client.execute(put);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        if (json != null) {
            recordId = json.getLongValue("recordId");
        }

        System.out.println(json);
    }

    put.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

    Entity JSON Format:

    {
    "medplantype": {
        "values": [
            {
                "code": "test001",
                "desc": "test001"
            }
        ]
    }
}

  4. Response Sample

    {
    "recordId": 29,
    "messages": [],
    "status": true
}

    {
    "recordId": 0,
    "messages": [
        {
            "msgDetail": "Same Code found(medplantype.code)",
            "msgCode": "core_101903"
        }
    ],
    "status": false
}

# Load Medical Plan Type

# Description

Usage: Load Medical Plan Type

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/read/medPlanType
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medPlanType
    id long (Query) Yes Medical Plan Type ID
    iRev long (Query) No Inner Version

  3. Request Sample

    JSONObject json = null;
CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {
    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/read/medPlanType";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medPlanType");
    paramStrBuilder.append("&id=").append(id);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "data": {
        "medplantype": [
            {
                "attachmentNo": 0,
                "lastModifyUid": 2894,
                "code": "jerry08",
                "useAccess": true,
                "expiredDate": -2209017600000,
                "iRev": 1,
                "sysJson": "",
                "viewCode": "medPlanType",
                "beId": 0,
                "expired": false,
                "printCount": 0,
                "useAccessBl": true,
                "udfjerry001": "",
                "id": 12,
                "statusModifyDate": 1537937535000,
                "locked": false,
                "desc_en": "医疗计划类型08",
                "lastModifyDate": 1537937535000,
                "createUid": 2894,
                "createDate": 1537937535000,
                "desc_zh-CN": "",
                "desc_pl": "",
                "lastApproveUid": 0,
                "desc_udfcn": "",
                "expiredUid": 0,
                "useAccessWl": false,
                "i18nField": "{\"desc_en\": \"医疗计划类型08\"}",
                "desc_zh-TW": "",
                "useAccessAutoCalc": false,
                "status": "N",
                "desc": "医疗计划类型08"
            }
        ]
    },
    "messages": [],
    "status": true
}

    {
    "data": {},
    "messages": [
        {
            "msgDetail": "No data is found, it may be deleted or not authorized for you to access",
            "msgCode": "core_141019"
        }
    ],
    "status": false
}

# Update Medical Plan Type

# Description

Usage: Update Medical Plan Type

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/save/medPlanType
    HTTP Method PUT
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medPlanType
    entitYes String (Body) Yes JSON (Refer to Request Sample)

  3. Request Sample

    long recordId = 0;

CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/save/medPlanType";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medPlanType");

    HttpPut put = new HttpPut(url + "?" + paramStrBuilder.toString());
    put.addHeader("authorization", access_token);
    put.addHeader("client_id", ClientID);

    StringEntity entity = new StringEntity(data.toJSONString(), ContentType.APPLICATION_JSON);
    entity.setContentEncoding("UTF-8");
    put.setEntity(entity);

    res = client.execute(put);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        if (json != null) {
            recordId = json.getLongValue("recordId");
        }

        System.out.println(json);
    }

    put.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

    Entity JSON Format:

    {
    "medplantype": {
        "values": [
            {
            	"id": 18
            }
        ]
    }
}

  4. Response Sample

    {
    "recordId": 18,
    "messages": [],
    "status": true
}

# Delete Medical Plan Type

# Description

Usage: Delete Medical Plan Type

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/delete/medPlanType
    HTTP Method DELETE
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medPlanType
    id long (Query) Yes Medical Plan Type ID

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/delete/medPlanType";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medPlanType");
    paramStrBuilder.append("&id=").append(id);

    HttpDelete delete = new HttpDelete(url + "?" + paramStrBuilder.toString());
    delete.addHeader("authorization", access_token);
    delete.addHeader("client_id", ClientID);

    res = client.execute(delete);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    delete.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "messages": [],
    "status": true
}

    {
    "messages": [
        {
            "msgDetail": "The record was deleted",
            "msgCode": "core_101017"
        }
    ],
    "status": false
}

# Medical Plan

# Fetch Medical Plan List

# Description

Usage: Fetch Medical Plan List

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/search/search
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    stSearch String (Query) Yes Lookup Type. You can find it in Lookup.
    （Eg: medicalPlan ......）
    formatId long (Query) No Lookup Query ID, If not specified, the default format is used.
    startRow int (Query) No Resultset offset : start index
    endRow int (Query) No Resultset offset : end index
    quickSearchStr String (Query) No Quick search keyword

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/search/search";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&stSearch=").append("medicalPlan");
    paramStrBuilder.append("&startRow=").append(0);
    paramStrBuilder.append("&endRow=").append(10);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "stSearch": "medicalPlan",
    "size": 10,
    "stSearchDisplay": "Medical Plan",
    "values": [
        {
            "code": "A001",
          	"desc":"医疗报销计划",
          	"medPlanType":1
          	"dependentAllow":1
          	"planPeriod":1
          	"planPeriodUnit":"year"
          	"planPeriodStartOn":"udf"
          	"planPeriodSpecDate":"joinDate"
          	"startmonth":0
          	"startday":0
          	"planStartAt":cur
          	"seniRequired":0
          	"seniCriteriaNum":0
          	"seniCriteriaCombo":"year"
          	"probaPassReq":1
          	"prorata":1
          	"roundingCombo":"no"
          	"roundingNum":0.0001
          	"maxCasePerCycle":10
          	"cur":3
          	"maxClaimPerCase"：5000
          	"maxClaimPerCycle":10000
          	"convering":100
          	"maxClaimChecking":"incApproved"
          	"varPayId":193
          	"defPaymentDate":"lastDay"
          	"paymentMonth":1
          	"paymentDay":0
          	"remarks"：           
            "status": "Y",
            "iRev": 1,
            "lastModifyDate": "2020-03-09 12:55:36",
            "medicalPlan.lastModifyUid.simpleUser.desc__lang": "admin-SC",
            "id": 12655,
            "st_desc": "00006MLTEST",
            "st_id": 12655,
            "st_code": "00006MLTEST"
        },
      {......}
    ]
}

# Create Medical Plan

# Description

Usage: Create Medical Plan

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/save/medicalPlan
    HTTP Method PUT
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medicalPlan
    entitYes String (Body) Yes JSON (Refer to Request Sample)

  3. Request Sample

    long recordId = 0;

CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/save/medicalPlan";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medicalPlan");

    HttpPut put = new HttpPut(url + "?" + paramStrBuilder.toString());
    put.addHeader("authorization", access_token);
    put.addHeader("client_id", ClientID);

    StringEntity entity = new StringEntity(data.toJSONString(), ContentType.APPLICATION_JSON);
    entity.setContentEncoding("UTF-8");
    put.setEntity(entity);

    res = client.execute(put);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        if (json != null) {
            recordId = json.getLongValue("recordId");
        }

        System.out.println(json);
    }

    put.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

    Entity JSON Format:

    {
    "medicalplan": {
        "values": [
            {
              	"code": "111",
            	"desc": "22",
                "medPlanType": 49,
                "startmonth": "1",
                "startday": "1"
            }
        ]
    }
}

  4. Response Sample

    {
    "recordId": 12724,
    "messages": [],
    "status": true
}

    {
    "recordId": 0,
    "messages": [
        {
            "msgDetail": "Invalid Data Found(medicalplan.medPlanType)",
            "msgCode": "core_143009"
        }
    ],
    "status": false
}

# Load Medical Plan

# Description

Usage: Load Medical Plan

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/read/medicalPlan
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medicalPlan
    id long (Query) Yes Medical Plan ID
    iRev long (Query) No Inner Version

  3. Request Sample

    JSONObject json = null;
CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {
    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/read/medicalPlan";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medicalPlan");
    paramStrBuilder.append("&id=").append(id);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "data": {
        "medicalplan": [
            {
                "lastModifyUid": 2628,
                "dependentAllow": true,
                "useAccess": false,
                "startday": 0,
                "expiredDate": -2209017600000,
                "sysJson": "",
                "viewCode": "medicalPlan",
                "beId": 0,
                "planStartAt": "cur",
                "paymentDay": 1,
                "useAccessBl": false,
                "prorata": false,
                "id": 2,
                "locked": false,
                "lastModifyDate": 1570758764000,
                "createUid": 2808,
                "startmonth": 0,
                "maxClaimPerCycle": 999999999,
                "defPaymentDate": "userDef",
                "desc_pl": "",
                "lastApproveUid": 0,
                "desc_udfcn": "",
                "expiredUid": 0,
                "i18nField": "{\"desc_en\": \"计划1EN\", \"desc_zh-CN\": \"计划1SC\", \"desc_zh-TW\": \"计划1TC\"}",
                "maxCasePerCycle": 9999,
                "desc_zh-TW": "计划1TC",
                "planPeriodStartOn": "Others",
                "status": "Y",
                "desc": "计划1SC",
                "medPlanType": 18,
                "cur": 40,
                "attachmentNo": 0,
                "planPeriod": 999,
                "code": "fq01",
                "roundingNum": 0.0001,
                "roundingCombo": "no",
                "convering": 50,
                "maxClaimPerCase": 999999999,
                "iRev": 29,
                "seniCriteriaCombo": "year",
                "expired": false,
                "printCount": 0,
                "varPayId": 374,
                "statusModifyDate": 1539829872000,
                "desc_en": "计划1EN",
                "planPeriodSpecDate": "joinDate",
                "createDate": 1539829872000,
                "seniRequired": false,
                "desc_zh-CN": "计划1SC",
                "maxClaimChecking": "incApproved",
                "seniCriteriaNum": 0,
                "useAccessWl": false,
                "probaPassReq": false,
                "planPeriodUnit": "day",
                "paymentMonth": 0,
                "useAccessAutoCalc": false,
                "remarks": "<p>医疗计划：1<br></p>"
            }
        ]
    },
    "messages": [],
    "status": true
}

    {
    "data": {},
    "messages": [
        {
            "msgDetail": "No data is found, it may be deleted or not authorized for you to access",
            "msgCode": "core_141019"
        }
    ],
    "status": false
}

# Update Medical Plan

# Description

Usage: Update Medical Plan

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/save/medicalPlan
    HTTP Method PUT
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medicalPlan
    entitYes String (Body) Yes JSON (Refer to Request Sample)

  3. Request Sample

    long recordId = 0;

CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/save/medicalPlan";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medicalPlan");

    HttpPut put = new HttpPut(url + "?" + paramStrBuilder.toString());
    put.addHeader("authorization", access_token);
    put.addHeader("client_id", ClientID);

    StringEntity entity = new StringEntity(data.toJSONString(), ContentType.APPLICATION_JSON);
    entity.setContentEncoding("UTF-8");
    put.setEntity(entity);

    res = client.execute(put);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        if (json != null) {
            recordId = json.getLongValue("recordId");
        }

        System.out.println(json);
    }

    put.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

    Entity JSON Format:

    {
    "medicalplan": {
        "values": [
            {
            	"id": 1,
            	"code": "111",
            	"desc": "22",
                "medPlanType": 1,
                "startmonth": "1",
                "startday": "1"
            }
        ]
    }
}

  4. Response Sample

    {
    "recordId": 1,
    "messages": [],
    "status": true
}

    {
    "recordId": 0,
    "messages": [
        {
            "msgDetail": "No data is found, it may be deleted or not authorized for you to access",
            "msgCode": "core_141019"
        }
    ],
    "status": false
}

# Delete Medical Plan

# Description

Usage: Delete Medical Plan

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/delete/medicalPlan
    HTTP Method DELETE
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medicalPlan
    id long (Query) Yes Medical Plan ID

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/delete/medicalPlan";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medicalPlan");
    paramStrBuilder.append("&id=").append(id);

    HttpDelete delete = new HttpDelete(url + "?" + paramStrBuilder.toString());
    delete.addHeader("authorization", access_token);
    delete.addHeader("client_id", ClientID);

    res = client.execute(delete);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    delete.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "messages": [],
    "status": true
}

    {
    "messages": [
        {
            "msgDetail": "The record was deleted",
            "msgCode": "core_101017"
        }
    ],
    "status": false
}

# Medical Claim

# Fetch Medical Claim List

# Description

Usage: Fetch Medical Claim List

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/search/search
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    stSearch String (Query) Yes Lookup Type. You can find it in Lookup.
    （Eg: medicalClaim ......）
    formatId long (Query) No Lookup Query ID, If not specified, the default format is used.
    startRow int (Query) No Resultset offset : start index
    endRow int (Query) No Resultset offset : end index
    quickSearchStr String (Query) No Quick search keyword

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/search/search";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&stSearch=").append("medicalClaim");
    paramStrBuilder.append("&startRow=").append(0);
    paramStrBuilder.append("&endRow=").append(10);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "stSearch": "medicalClaim",
    "size": 1,
    "stSearchDisplay": "Medical Claim",
    "values": [
        {
            "code": "E_MEC_1542362265291",
            "status": "Y",
            "iRev": 7,
            "lastModifyDate": "2021-08-05 18:04:18",
            "medicalClaim.lastModifyUid.simpleUser.desc__lang": "admin123",
            "id": 38,
            "st_desc": "E_MEC_1542362265291",
            "st_id": 38,
            "st_code": "E_MEC_1542362265291"
        }
    ]
}

# Create Medical Claim

# Description

Usage: Create Medical Claim

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/save/medicalClaim
    HTTP Method PUT
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medicalClaim
    entitYes String (Body) Yes JSON (Refer to Request Sample)

  3. Request Sample

    long recordId = 0;

CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/save/medicalClaim";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medicalClaim");

    HttpPut put = new HttpPut(url + "?" + paramStrBuilder.toString());
    put.addHeader("authorization", access_token);
    put.addHeader("client_id", ClientID);

    StringEntity entity = new StringEntity(data.toJSONString(), ContentType.APPLICATION_JSON);
    entity.setContentEncoding("UTF-8");
    put.setEntity(entity);

    res = client.execute(put);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        if (json != null) {
            recordId = json.getLongValue("recordId");
        }

        System.out.println(json);
    }

    put.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

    Entity JSON Format:

    {
    "medicalclaim": {
        "values": [
            {
                "empId": 12,
                "medPlanId": 13,
                "invoiceDate":"2022-09-10",
                "amount": 10
            }
        ]
    }
}

  4. Response Sample

    {
    "recordId": 1675,
    "messages": [],
    "status": true
}

    {
    "recordId": 0,
    "messages": [
        {
            "msgDetail": "Required field is empty(medicalclaim.empId)",
            "msgCode": "core_101905"
        }
    ],
    "status": false
}

# Load Medical Claim

# Description

Usage: Load Medical Claim

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/read/medicalClaim
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medicalClaim
    id long (Query) Yes Medical Claim ID
    iRev long (Query) No Inner Version

  3. Request Sample

    JSONObject json = null;
CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {
    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/read/medicalClaim";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medicalClaim");
    paramStrBuilder.append("&id=").append(id);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "data": {
        "medicalclaim": [
            {
                "empId": 13532,
                "attachmentNo": 0,
                "lastModifyUid": 4,
                "code": "MC20030008",
                "useAccess": false,
                "expiredDate": -2209017600000,
                "iRev": 5,
                "sysJson": "{\"autoGenCode\":{\"snId\":149,\"sn\":\"8\"}}",
                "viewCode": "medicalClaim",
                "beId": 0,
                "expired": false,
                "paymentDay": 1593446400000,
                "printCount": 0,
                "useAccessBl": false,
                "id": 1568,
                "statusModifyDate": 1584960879000,
                "locked": false,
                "medPlanId": 10,
                "lastModifyDate": 1629268342000,
                "dependent": 0,
                "createUid": 4,
                "createDate": 1584960879000,
                "amount": 10,
                "lastApproveUid": 4,
                "invoiceDate": 1590854400000,
                "expiredUid": 0,
                "useAccessWl": false,
                "useAccessAutoCalc": false,
                "remarks": "",
                "status": "Y"
            }
        ]
    },
    "messages": [],
    "status": true
}

    {
    "data": {},
    "messages": [
        {
            "msgDetail": "No data is found, it may be deleted or not authorized for you to access",
            "msgCode": "core_141019"
        }
    ],
    "status": false
}

# Update Medical Claim

# Description

Usage: Update Medical Claim

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/save/medicalClaim
    HTTP Method PUT
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medicalClaim
    entitYes String (Body) Yes JSON (Refer to Request Sample)

  3. Request Sample

    long recordId = 0;

CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/save/medicalClaim";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medicalClaim");

    HttpPut put = new HttpPut(url + "?" + paramStrBuilder.toString());
    put.addHeader("authorization", access_token);
    put.addHeader("client_id", ClientID);

    StringEntity entity = new StringEntity(data.toJSONString(), ContentType.APPLICATION_JSON);
    entity.setContentEncoding("UTF-8");
    put.setEntity(entity);

    res = client.execute(put);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        if (json != null) {
            recordId = json.getLongValue("recordId");
        }

        System.out.println(json);
    }

    put.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

    Entity JSON Format:

    {
    "medicalclaim": {
        "values": [
            {
                "id": 1568,
                "medPlanId": 13,
                "invoiceDate":"2022-09-10",
                "amount": 10
            }
        ]
    }
}

  4. Response Sample

    {
    "recordId": 1568,
    "messages": [],
    "status": true
}

    {
    "recordId": 0,
    "messages": [
        {
            "msgDetail": "Required field is empty(medicalclaim.medPlanId)",
            "msgCode": "core_101905"
        }
    ],
    "status": false
}

# Delete Medical Claim

# Description

Usage: Delete Medical Claim

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/root/api/delete/medicalClaim
    HTTP Method DELETE
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    menuCode String (Query) Yes In Data Dictionary
    Eg: medicalClaim
    id long (Query) Yes Medical Claim ID

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/root/api/delete/medicalClaim";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&menuCode=").append("medicalClaim");
    paramStrBuilder.append("&id=").append(id);

    HttpDelete delete = new HttpDelete(url + "?" + paramStrBuilder.toString());
    delete.addHeader("authorization", access_token);
    delete.addHeader("client_id", ClientID);

    res = client.execute(delete);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    delete.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "messages": [],
    "status": true
}

    {
    "messages": [
        {
            "msgDetail": "The record was deleted",
            "msgCode": "core_101017"
        }
    ],
    "status": false
}

# Load EBI data

# Medical Plan Listing

# Description

Usage: Run EBI [Medical Plan Listing], return EBI data

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/ebiWidget/loadReport
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    formatId long (Query) Yes Format ID fetched from another API
    offset int (Query) No Resultset offset : start index
    rows int (Query) No Resultset offset : end index

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/ebiWidget/loadReport";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&formatId=").append(formatId);
    paramStrBuilder.append("&offset=").append(0);
    paramStrBuilder.append("&rows=").append(3);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "size": 1,
    "rows": [
        {
            "T4_A_cur": "3",
            "T4_A_maxClaimChecking": "Include approved medical claim records only within maximum claim per plan checking",
            "T4_A_varPayId_desc__lang": "Extra Wages (Input)-简体",
            "T4_A_planStartAt": "The current medical plan period once conditions are met",
            "aiM18ReservedCol_dataIndex": 1,
            "T4_A_varPayId_code": "102EXWGPX",
            "T4_A_cur_desc__lang": "￥",
            "T4_A_planPeriod": "1",
            "T4_A_paymentMonth": "1",
            "T4_A_planPeriodUnit": "Year",
            "T4_A_startday": "1",
            "T4_A_seniCriteriaNum": "0",
            "T4_A_iRev": "11",
            "T4_A_desc__lang": "",
            "T4_A_cur_code": "RMB",
            "T4_A_maxClaimPerCase": "5,000.00",
            "T4_A_varPayId": "193",
            "T4_A_startmonth": "1",
            "T4_A_id": "1",
            "T4_A_defPaymentDate": "Last Day",
            "T4_A_seniCriteriaCombo": "Year",
            "T4_A_code": "111"
        }
    ]
}

    MEDICALPLAN_EBI

# Employee Medical Plan Report

# Description

Usage: Run EBI [Employee Medical Plan Report], return EBI data

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/ebiWidget/loadReport
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    formatId long (Query) Yes Format ID fetched from another API
    offset int (Query) No Resultset offset : start index
    rows int (Query) No Resultset offset : end index

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/ebiWidget/loadReport";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&formatId=").append(formatId);
    paramStrBuilder.append("&offset=").append(0);
    paramStrBuilder.append("&rows=").append(1);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "size": 1,
    "rows": [
        {
            "T2_B_code": "111",
            "MAIN_hId": "4,027",
            "aiM18ReservedCol_dataIndex": 1,
            "T2_A_endDate": "9999-12-31",
            "T2_B_desc__lang": "",
            "T2_A_startDate": "2018-10-01",
            "T2_B_id": "1"
        }
    ]
}

    EMPMEDPLAN_EBI

# Employee Medical Claim Report

# Description

Usage: Run EBI [Employee Medical Claim Report], return EBI data

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/ebiWidget/loadReport
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    formatId long (Query) Yes Format ID fetched from another API
    offset int (Query) No Resultset offset : start index
    rows int (Query) No Resultset offset : end index

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/ebiWidget/loadReport";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&formatId=").append(formatId);
    paramStrBuilder.append("&offset=").append(0);
    paramStrBuilder.append("&rows=").append(1);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "size": 1,
    "rows": [
        {
            "T2_A_invoiceDate": "2022-05-23",
            "T2_A_locked": "No",
            "aiM18ReservedCol_dataIndex": 1,
            "T2_A_amount": "10.00",
            "T2_A_id": "1563",
            "T2_A_paymentDay": "2022-06-30",
            "T2_A_code": "MC20010003"
        }
    ]
}

    EMPMEDCLAIM_EBI

# Medical Claim Balance Report

# Description

Usage: Run EBI [Medical Claim Balance Report], return EBI data

# API Detail

  1. Request URL

    URL http://[server]/jsf/rfws/ebiWidget/loadReport
    HTTP Method GET
    Encode UTF-8

  2. URL Parameters

    Parameter Type Required Remarks
    authorization String (Header) Yes Access Token obtained via Oauth2
    client_id String (Header) Yes Client ID from [OAuth Applications], generated by the aiM18
    formatId long (Query) Yes Format ID fetched from another API
    offset int (Query) No Resultset offset : start index
    rows int (Query) No Resultset offset : end index

  3. Request Sample

    CloseableHttpClient client = HttpClientBuilder.create().build();
CloseableHttpResponse res = null;
try {

    String url = "http://" + HostIP + ":" + HostPort + "/jsf/rfws/ebiWidget/loadReport";

    StringBuilder paramStrBuilder = new StringBuilder();
    paramStrBuilder.append("&formatId=").append(formatId);
    paramStrBuilder.append("&offset=").append(0);
    paramStrBuilder.append("&rows=").append(10);

    HttpGet get = new HttpGet(url + "?" + paramStrBuilder.toString());
    get.addHeader("authorization", access_token);
    get.addHeader("client_id", ClientID);
    res = client.execute(get);
    if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
        JSONObject json = JSON.parseObject(EntityUtils.toString(res.getEntity()));

        System.out.println(json);
    }

    get.releaseConnection();
} catch (Exception e) {
    e.printStackTrace();
} finally {
    try {
        if (res != null) {
            res.close();
        }
        if (client != null) {
            client.close();
        }
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

  4. Response Sample

    {
    "size": 1,
    "rows": [
        {
            "T2_A_convering": "80.00",
            "T2_A_probaPassReq": "Yes",
            "T2_A_varPayId": "0",
            "aiM18ReservedCol_dataIndex": 1,
            "MAIN_medClaimBal": "10,000.00",
            "T2_A_seniCriteriaNum": "9",
            "T2_A_desc__lang": "",
            "T2_A_maxCasePerCycle": "1",
            "T2_A_cur_code": "",
            "T2_A_prorata": "No",
            "T2_A_cur": "0",
            "T2_A_useAccessAutoCalc": "No",
            "T2_A_planPeriodSpecDate": "Join Date",
            "T2_A_planPeriodStartOn": "Other",
            "T2_A_maxClaimChecking": "Include approved medical claim records only within maximum claim per plan checking",
            "T2_A_code": "KNMP001",
            "T2_A_varPayId_desc__lang": "",
            "MAIN_claimedAmount": "0.00",
            "T2_A_seniRequired": "No",
            "T2_A_seniCriteriaCombo": "Year",
            "T2_A_roundingCombo": "No Rounding",
            "T2_A_id": "3",
            "T2_A_planPeriodUnit": "Year",
            "T2_A_paymentMonth": "1",
            "T2_A_maxClaimPerCase": "1,000.00",
            "T2_A_startday": "0",
            "T2_A_varPayId_code": "",
            "T2_A_dependentAllow": "Yes",
            "T2_A_maxClaimPerCycle": "10,000.00",
            "T2_A_planStartAt": "The next medical plan period once conditions are met"
        }
    ]
}

    MEDCLAIMBAL_EBI

Last Updated: 2025/05/29, 08:57:55
Leave
Payroll

← Payroll→

Theme by Vdoing | Copyright © 1990-2025 Multiable | MIT License