Retrieve miscellaneous parameter definitions for benefit types
curl --request POST \
--url https://ste.symmetry.com/ste-hosted/v2/benefitParameterData \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"BenefitParameterDataRequest": {
"benefitType": [],
"payDate": "<string>"
}
}
'import requests
url = "https://ste.symmetry.com/ste-hosted/v2/benefitParameterData"
payload = { "BenefitParameterDataRequest": {
"benefitType": [],
"payDate": "<string>"
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({BenefitParameterDataRequest: {benefitType: [], payDate: '<string>'}})
};
fetch('https://ste.symmetry.com/ste-hosted/v2/benefitParameterData', 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://ste.symmetry.com/ste-hosted/v2/benefitParameterData",
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([
'BenefitParameterDataRequest' => [
'benefitType' => [
],
'payDate' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "https://ste.symmetry.com/ste-hosted/v2/benefitParameterData"
payload := strings.NewReader("{\n \"BenefitParameterDataRequest\": {\n \"benefitType\": [],\n \"payDate\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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("https://ste.symmetry.com/ste-hosted/v2/benefitParameterData")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BenefitParameterDataRequest\": {\n \"benefitType\": [],\n \"payDate\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ste.symmetry.com/ste-hosted/v2/benefitParameterData")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BenefitParameterDataRequest\": {\n \"benefitType\": [],\n \"payDate\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"errorStatus": {
"errorCode": 123,
"errorMessage": "<string>"
},
"transactionStamp": {
"calcDateTime": "<string>",
"failedTransactions": 123,
"schemaVersion": "<string>",
"steVersion": "<string>",
"totalTransactions": 123
},
"benefitCollection": [
{
"benefitParameterData": [
{
"parameterName": "<string>",
"description": "<string>",
"regex": "<string>",
"regexDescription": "<string>",
"listValues": "<string>",
"defaultValue": "<string>",
"helpText": "<string>",
"isOptional": true,
"taxEffectiveDate": "<string>"
}
]
}
]
}Retrieve miscellaneous parameter definitions for benefit types
Given one or more benefit types and a pay date, returns the date-effective miscellaneous parameter definitions for each type — including name, data type, default value, validation pattern, pick-list values, and help text. This is the benefit analog of /v1/jurisdictionData and is purely informational.
POST
/
v2
/
benefitParameterData
Retrieve miscellaneous parameter definitions for benefit types
curl --request POST \
--url https://ste.symmetry.com/ste-hosted/v2/benefitParameterData \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"BenefitParameterDataRequest": {
"benefitType": [],
"payDate": "<string>"
}
}
'import requests
url = "https://ste.symmetry.com/ste-hosted/v2/benefitParameterData"
payload = { "BenefitParameterDataRequest": {
"benefitType": [],
"payDate": "<string>"
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({BenefitParameterDataRequest: {benefitType: [], payDate: '<string>'}})
};
fetch('https://ste.symmetry.com/ste-hosted/v2/benefitParameterData', 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://ste.symmetry.com/ste-hosted/v2/benefitParameterData",
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([
'BenefitParameterDataRequest' => [
'benefitType' => [
],
'payDate' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "https://ste.symmetry.com/ste-hosted/v2/benefitParameterData"
payload := strings.NewReader("{\n \"BenefitParameterDataRequest\": {\n \"benefitType\": [],\n \"payDate\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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("https://ste.symmetry.com/ste-hosted/v2/benefitParameterData")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BenefitParameterDataRequest\": {\n \"benefitType\": [],\n \"payDate\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ste.symmetry.com/ste-hosted/v2/benefitParameterData")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BenefitParameterDataRequest\": {\n \"benefitType\": [],\n \"payDate\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"errorStatus": {
"errorCode": 123,
"errorMessage": "<string>"
},
"transactionStamp": {
"calcDateTime": "<string>",
"failedTransactions": 123,
"schemaVersion": "<string>",
"steVersion": "<string>",
"totalTransactions": 123
},
"benefitCollection": [
{
"benefitParameterData": [
{
"parameterName": "<string>",
"description": "<string>",
"regex": "<string>",
"regexDescription": "<string>",
"listValues": "<string>",
"defaultValue": "<string>",
"helpText": "<string>",
"isOptional": true,
"taxEffectiveDate": "<string>"
}
]
}
]
}Authorizations
API key for authentication. Provide the raw key as the value of the Authorization header (no "Bearer" prefix).
Body
application/jsonapplication/xml
Show child attributes
Show child attributes
⌘I

