InsEnrollmentService:findEnrollees

Luokka:InsEnrollmentService

Metodi:findEnrollees

Miten se toimii?

1. Palvelu vastaanottaa jäsennetyn JSON-tiedoston.

2. Jos jäsennellyllä objektilla on searchKey-parametri, se noutaa luettelon yhteyshenkilöille, joilla on etunimi, sukunimi tai jäsenen tunnus, joka alkaa määritetyllä searchKey-avaimella.

   • Palvelu ei palauta oletusarvoisesti yhteyshenkilöitä, joilla on vanhentuneet käytännöt.

   • Jos jäsennellyllä objektilla on productType-parametri, haettujen yhteyshenkilöiden luettelo suodatetaan tarkemmin käytännön tuotetyypin mukaan.

   • Jos jäsennellyllä objektilla on includeExpiredPolicies-parametri, yhteyshenkilöt noudetaan riippumatta niiden käytännön vanhenemispäivästä.

3. Palvelu noutaa käytäntöjen luettelon ja kartoittaa ne kaikkiin noudettuihin yhteyshenkilöihin, kunhan heidän ryhmänsä on määritetty tilin tunnus.

   • Jos syötetty arvo sisältää effectiveDate-arvon, vain käytännöt, joilla on sama voimaanastumispäivä, noudetaan.

   • Jos input-arvo sisältää productType-arvon, vain käytännöt, joilla on sama productType, noudetaan.

   • Jos syöttöjoukot sisältävät ExpiredPolicies-arvoksi true, myös vanhentuneet vakuutukset noudetaan.

4. Noudettu osallistujien luettelo ja kaikki kohdistetut käytännön lisätiedot palautetaan datanoodissa.

Syötteet

Syötetty JSON

JSON-syötteen muotoilu seuraavasti:

{
  "searchKey": String,
  "productType": productType,
  "includeExpiredPolicies": Boolean
}

Esimerkki datan sisältävästä JSON-syötteestä:

{
    "searchKey": "Adam",
    "productType": "Medical",
    "includeExpiredPolicies": true
}

Tulos-JSON

JSON-tulos on osallistujien luettelo, jolla on seuraavat ominaisuudet fields-noodin alla:

{
  "data": {
    "records": [
      {
        "fields": {
          "Id": "0035w000039SsoSAAS",
		  "AccountId": "0015w00002ADHiPAAX",
          "LastName": "C2P1",
          "FirstName": "P1",
		  "Name": "C2P1 P1"
        }
      }
    ]
  }
}

Esimerkki datan sisältävästä JSON-tuloksesta:

{
  "data": [
    {
      "AccountId": "0013h00000Gx5UqAAJ",
      "Id": "0033h00000BBybMAAT",
      "LastName": "C1P1",
      "FirstName": "D1",
      "Name": "D1 C1P1"
    },
    {
      "AccountId": "0013h00000Gx5UqAAJ",
      "Id": "0033h00000BBybPAAT",
      "LastName": "C1P2",
      "FirstName": "D1",
      "Name": "D1 C1P2"
    },
    {
      "AccountId": "0013h00000Gx5UrAAJ",
      "Id": "0033h00000BBybSAAT",
      "LastName": "C2P1",
      "FirstName": "D1",
      "Name": "D1 C2P1"
    }
  ],
  "error": "OK"
}