Get Benefit Coverage By Id

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

import requests

url = "https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}"

headers = {
    "x-connector-token": "<x-connector-token>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-connector-token': '<x-connector-token>', Authorization: 'Bearer <token>'}
};

fetch('https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-connector-token: <x-connector-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-connector-token", "<x-connector-token>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}")
  .header("x-connector-token", "<x-connector-token>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-connector-token"] = '<x-connector-token>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "2023-11-07T05:31:56Z",
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "currency": "USD",
  "amount": 50000,
  "benefit": "018b18ef-c488-7d40-9131-91bbc47c1007",
  "covered_dependents": [
    "018abccb-c4a9-72f6-be1d-3fc7aaf2be67"
  ],
  "is_employee_covered": true,
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

GET

api

hris

benefit-coverages

{id}

Get Benefit Coverage By Id

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

import requests

url = "https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}"

headers = {
    "x-connector-token": "<x-connector-token>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-connector-token': '<x-connector-token>', Authorization: 'Bearer <token>'}
};

fetch('https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-connector-token: <x-connector-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-connector-token", "<x-connector-token>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}")
  .header("x-connector-token", "<x-connector-token>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bindbee.dev/api/hris/v1/benefit-coverages/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-connector-token"] = '<x-connector-token>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "2023-11-07T05:31:56Z",
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "currency": "USD",
  "amount": 50000,
  "benefit": "018b18ef-c488-7d40-9131-91bbc47c1007",
  "covered_dependents": [
    "018abccb-c4a9-72f6-be1d-3fc7aaf2be67"
  ],
  "is_employee_covered": true,
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token

string

required

Path Parameters

string<uuid>

required

Query Parameters

include_raw_data

boolean

default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

Example:

false

expand

string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:

"manager[first_name,last_name]"

Response

Successful Response

The Hris Benefit Coverage object is used to represent the coverage amount associated with a benefit enrollment.

string<uuid>

required

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

modified_at

string<date-time>

required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields

Custom Fields · object | null

required

The custom fields related to the model

Example:

{
  "category_group": "REG",
  "disability_type": "ASBERG",
  "hire_date": "1991-03-16T00:00:00",
  "hire_source": "REFER",
  "nationality": "USA",
  "original_hire_date": "1991-03-16T00:00:00"
}

currency

string | null

required

Currency of the coverage amount, such as USD, INR, or EUR.

Example:

"USD"

amount

required

Coverage amount associated with the benefit.

Example:

50000

benefit

any | null

required

The benefit enrollment this coverage is associated with.

Example:

"018b18ef-c488-7d40-9131-91bbc47c1007"

covered_dependents

any[] | null

required

The dependents covered under the benefit.

Example:

["018abccb-c4a9-72f6-be1d-3fc7aaf2be67"]

is_employee_covered

boolean | null

required

Indicates whether the employee is covered under the benefit.

Example:

true

raw_data

Raw Data · object | null

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}