cURL
curl --request POST \
--url http://localhost:8080/benefits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"benefit_details": {
"benefit_type": "CONSULTATION",
"description": "<string>"
},
"name": "<string>",
"provider_id": "<string>",
"description": "<string>"
}
'import requests
url = "http://localhost:8080/benefits"
payload = {
"benefit_details": {
"benefit_type": "CONSULTATION",
"description": "<string>"
},
"name": "<string>",
"provider_id": "<string>",
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
benefit_details: {benefit_type: 'CONSULTATION', description: '<string>'},
name: '<string>',
provider_id: '<string>',
description: '<string>'
})
};
fetch('http://localhost:8080/benefits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/benefits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'benefit_details' => [
'benefit_type' => 'CONSULTATION',
'description' => '<string>'
],
'name' => '<string>',
'provider_id' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/benefits"
payload := strings.NewReader("{\n \"benefit_details\": {\n \"benefit_type\": \"CONSULTATION\",\n \"description\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/benefits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"benefit_details\": {\n \"benefit_type\": \"CONSULTATION\",\n \"description\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/benefits")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"benefit_details\": {\n \"benefit_type\": \"CONSULTATION\",\n \"description\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"benefit_details": {
"benefit_type": "CONSULTATION",
"description": "<string>"
},
"created_at": "<string>",
"id": "<string>",
"last_modified_at": "<string>",
"name": "<string>",
"provider_id": "<string>",
"provider_name": "<string>",
"description": "<string>"
}Benefits
Create Benefit
POST
/
benefits
cURL
curl --request POST \
--url http://localhost:8080/benefits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"benefit_details": {
"benefit_type": "CONSULTATION",
"description": "<string>"
},
"name": "<string>",
"provider_id": "<string>",
"description": "<string>"
}
'import requests
url = "http://localhost:8080/benefits"
payload = {
"benefit_details": {
"benefit_type": "CONSULTATION",
"description": "<string>"
},
"name": "<string>",
"provider_id": "<string>",
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
benefit_details: {benefit_type: 'CONSULTATION', description: '<string>'},
name: '<string>',
provider_id: '<string>',
description: '<string>'
})
};
fetch('http://localhost:8080/benefits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/benefits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'benefit_details' => [
'benefit_type' => 'CONSULTATION',
'description' => '<string>'
],
'name' => '<string>',
'provider_id' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/benefits"
payload := strings.NewReader("{\n \"benefit_details\": {\n \"benefit_type\": \"CONSULTATION\",\n \"description\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/benefits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"benefit_details\": {\n \"benefit_type\": \"CONSULTATION\",\n \"description\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/benefits")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"benefit_details\": {\n \"benefit_type\": \"CONSULTATION\",\n \"description\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"benefit_details": {
"benefit_type": "CONSULTATION",
"description": "<string>"
},
"created_at": "<string>",
"id": "<string>",
"last_modified_at": "<string>",
"name": "<string>",
"provider_id": "<string>",
"provider_name": "<string>",
"description": "<string>"
}Authorizations
JWT bearer token. App-user tokens are issued by POST /auth/token (the partner backend calls it as its platform service account); admin and dashboard tokens are issued via OIDC login.
Body
application/json
Response
Benefit created
- Option 1
- Option 2
Show child attributes
Show child attributes
Kind of benefit offered by a provider.
Available options:
CONSULTATION, INSURANCE_POLICY Benefit lifecycle status.
Available options:
ACTIVE, INACTIVE ⌘I