Get the caller's compensation role, salary band and placement.
curl --request GET \
--url https://{tenantHost}/api/v1/portal/employee/compensationimport requests
url = "https://{tenantHost}/api/v1/portal/employee/compensation"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{tenantHost}/api/v1/portal/employee/compensation', 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://{tenantHost}/api/v1/portal/employee/compensation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://{tenantHost}/api/v1/portal/employee/compensation"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenantHost}/api/v1/portal/employee/compensation")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantHost}/api/v1/portal/employee/compensation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"role": {
"code": "<string>",
"name": "<string>",
"nameEn": "<string>",
"nameFr": "<string>",
"description": "<string>",
"descriptionEn": "<string>",
"descriptionFr": "<string>",
"level": 0
},
"placement": {
"effectiveFrom": "2023-11-07T05:31:56Z",
"stepNumber": 0,
"note": "<string>"
},
"band": {
"shape": "RANGE",
"validFrom": "2023-11-07T05:31:56Z",
"fullTime": {
"minAnnual": "<string>",
"maxAnnual": "<string>",
"steps": [
{
"stepNumber": 0,
"annualAmount": "<string>"
}
]
},
"atWorkload": {
"minAnnual": "<string>",
"maxAnnual": "<string>",
"steps": [
{
"stepNumber": 0,
"annualAmount": "<string>"
}
]
}
},
"workloadPercent": 0,
"actualSalary": {
"monthlyAmount": "<string>",
"hourlyRate": "<string>",
"annualizedAmount": "<string>",
"thirteenthMonthEnabled": true
},
"showActualSalary": true,
"factors": [
{
"id": "<string>",
"name": "<string>",
"nameEn": "<string>",
"nameFr": "<string>",
"description": "<string>",
"descriptionEn": "<string>",
"descriptionFr": "<string>",
"unitLabel": "<string>",
"unitLabelEn": "<string>",
"unitLabelFr": "<string>",
"valueKind": "NUMERIC",
"value": "<string>",
"note": "<string>",
"stepsPerUnit": "<string>",
"maxSteps": "<string>",
"contributionSteps": "<string>",
"assessedAt": "2023-11-07T05:31:56Z"
}
],
"referencePosition": {
"totalSteps": "<string>",
"stepNumber": 0,
"clamped": true,
"fullTimeAnnualAmount": "<string>",
"atWorkloadAnnualAmount": "<string>"
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}compensation
Get the caller's compensation role, salary band and placement.
GET
/
api
/
v1
/
portal
/
employee
/
compensation
Get the caller's compensation role, salary band and placement.
curl --request GET \
--url https://{tenantHost}/api/v1/portal/employee/compensationimport requests
url = "https://{tenantHost}/api/v1/portal/employee/compensation"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{tenantHost}/api/v1/portal/employee/compensation', 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://{tenantHost}/api/v1/portal/employee/compensation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://{tenantHost}/api/v1/portal/employee/compensation"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenantHost}/api/v1/portal/employee/compensation")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantHost}/api/v1/portal/employee/compensation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"role": {
"code": "<string>",
"name": "<string>",
"nameEn": "<string>",
"nameFr": "<string>",
"description": "<string>",
"descriptionEn": "<string>",
"descriptionFr": "<string>",
"level": 0
},
"placement": {
"effectiveFrom": "2023-11-07T05:31:56Z",
"stepNumber": 0,
"note": "<string>"
},
"band": {
"shape": "RANGE",
"validFrom": "2023-11-07T05:31:56Z",
"fullTime": {
"minAnnual": "<string>",
"maxAnnual": "<string>",
"steps": [
{
"stepNumber": 0,
"annualAmount": "<string>"
}
]
},
"atWorkload": {
"minAnnual": "<string>",
"maxAnnual": "<string>",
"steps": [
{
"stepNumber": 0,
"annualAmount": "<string>"
}
]
}
},
"workloadPercent": 0,
"actualSalary": {
"monthlyAmount": "<string>",
"hourlyRate": "<string>",
"annualizedAmount": "<string>",
"thirteenthMonthEnabled": true
},
"showActualSalary": true,
"factors": [
{
"id": "<string>",
"name": "<string>",
"nameEn": "<string>",
"nameFr": "<string>",
"description": "<string>",
"descriptionEn": "<string>",
"descriptionFr": "<string>",
"unitLabel": "<string>",
"unitLabelEn": "<string>",
"unitLabelFr": "<string>",
"valueKind": "NUMERIC",
"value": "<string>",
"note": "<string>",
"stepsPerUnit": "<string>",
"maxSteps": "<string>",
"contributionSteps": "<string>",
"assessedAt": "2023-11-07T05:31:56Z"
}
],
"referencePosition": {
"totalSteps": "<string>",
"stepNumber": 0,
"clamped": true,
"fullTimeAnnualAmount": "<string>",
"atWorkloadAnnualAmount": "<string>"
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}