Actions
The ballerinax/sap.successfactors.employeecentralec package exposes the following clients:
Available clients:
| Client | Purpose |
|---|---|
Client | Manages employeecentralec objects: PerGlobalInfoARE, PerGlobalInfoCHN, PerGlobalInfoFIN, EducationDegreeContent, CurrencyExchangeRate, NonRecurringPayment, EducationDegreeEntity, ServiceDeskContactSupportInformation…, over the SAP SuccessFactors OData v2 API. |
Client
You can use these APIs to access the country specific global information of an employee.
Configuration
ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with the SAP SuccessFactors OData endpoint. Passed as the argument to the client initializer.
| Field | Type | Default | Description |
|---|---|---|---|
auth | http:CredentialsConfig | Required | Configurations related to client authentication |
httpVersion | http:HttpVersion | See default | The HTTP version understood by the client |
http1Settings | http:ClientHttp1Settings | See default | Configurations related to HTTP/1.x protocol |
http2Settings | http:ClientHttp2Settings | See default | Configurations related to HTTP/2 protocol |
timeout | decimal | See default | The maximum time to wait (in seconds) for a response before closing the connection |
forwarded | string | See default | The choice of setting forwarded/x-forwarded header |
followRedirects | http:FollowRedirects | Optional | Configurations associated with Redirection |
poolConfig | http:PoolConfiguration | Optional | Configurations associated with request pooling |
cache | http:CacheConfig | See default | HTTP caching related configurations |
compression | http:Compression | See default | Specifies the way of handling compression (accept-encoding) header |
circuitBreaker | http:CircuitBreakerConfig | Optional | Configurations associated with the behaviour of the Circuit Breaker |
retryConfig | http:RetryConfig | Optional | Configurations associated with retrying |
cookieConfig | http:CookieConfig | Optional | Configurations associated with cookies |
responseLimits | http:ResponseLimitConfigs | See default | Configurations associated with inbound response size limits |
secureSocket | http:ClientSecureSocket | Optional | SSL/TLS-related options |
proxy | http:ProxyConfig | Optional | Proxy server related options |
socketConfig | http:ClientSocketConfig | See default | Provides settings related to client socket configuration |
validation | boolean | See default | Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default |
laxDataBinding | boolean | See default | Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default. |
The client also accepts a hostname string parameter (the SAP SuccessFactors API server host) and an optional port (defaults to 443).
Initializing the client
import ballerinax/sap.successfactors.employeecentralec;
configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;
employeecentralec:Client client = check new (
{
auth: { username, password }
},
hostname
);
Operations
PerGlobalInfoARE
listPerGlobalInfoAREs
Queries the PerGlobalInfoARE collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoAREsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoAREsResponse|error
Sample code:
ListPerGlobalInfoAREsResponse result = check client->listPerGlobalInfoAREs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoARE
Retrieves a single PerGlobalInfoARE entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoAREQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoARE_1|error
Sample code:
PerGlobalInfoARE_1 result = check client->getPerGlobalInfoARE(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoCHN
listPerGlobalInfoCHNs
Queries the PerGlobalInfoCHN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoCHNsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoCHNsResponse|error
Sample code:
ListPerGlobalInfoCHNsResponse result = check client->listPerGlobalInfoCHNs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoCHN
Retrieves a single PerGlobalInfoCHN entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoCHNQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoCHN_1|error
Sample code:
PerGlobalInfoCHN_1 result = check client->getPerGlobalInfoCHN(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoFIN
listPerGlobalInfoFINs
Queries the PerGlobalInfoFIN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoFINsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoFINsResponse|error
Sample code:
ListPerGlobalInfoFINsResponse result = check client->listPerGlobalInfoFINs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoFIN
Retrieves a single PerGlobalInfoFIN entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoFINQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoFIN_1|error
Sample code:
PerGlobalInfoFIN_1 result = check client->getPerGlobalInfoFIN(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
EducationDegreeContent
listEducationDegreeContents
Queries the EducationDegreeContent collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEducationDegreeContentsQueries | No | Queries to be sent with the request |
Returns: ListEducationDegreeContentsResponse|error
Sample code:
ListEducationDegreeContentsResponse result = check client->listEducationDegreeContents();
Sample response:
{
"d": {
"results": [
{
"JobProfile_externalCode": "1000",
"externalCode": "1000",
"entityNav": {}
}
]
}
}
createEducationDegreeContent
Creates a new EducationDegreeContent entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EducationDegreeContent | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEducationDegreeContent|error
Sample code:
CreatedEducationDegreeContent result = check client->createEducationDegreeContent(payload);
Sample response:
{
"d": {
"JobProfile_externalCode": "1000",
"externalCode": "1000",
"entityNav": {
"externalCode": "1000"
}
}
}
getEducationDegreeContent
Retrieves a single EducationDegreeContent entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
JobProfile_externalCode | string | Yes | key: JobProfile_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEducationDegreeContentQueries | No | Queries to be sent with the request |
Returns: EducationDegreeContent_1|error
Sample code:
EducationDegreeContent_1 result = check client->getEducationDegreeContent(JobProfile_externalCode, externalCode);
Sample response:
{
"d": {
"JobProfile_externalCode": "1000",
"externalCode": "1000",
"entityNav": {
"externalCode": "1000"
}
}
}
updateEducationDegreeContent
Updates the EducationDegreeContent identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
JobProfile_externalCode | string | Yes | key: JobProfile_externalCode |
externalCode | string | Yes | key: externalCode |
payload | ModifiedEducationDegreeContent | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEducationDegreeContent(JobProfile_externalCode, externalCode, payload);
deleteEducationDegreeContent
Deletes the EducationDegreeContent identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
JobProfile_externalCode | string | Yes | key: JobProfile_externalCode |
externalCode | string | Yes | key: externalCode |
headers | DeleteEducationDegreeContentHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEducationDegreeContent(JobProfile_externalCode, externalCode);
CurrencyExchangeRate
listCurrencyExchangeRates
Queries the CurrencyExchangeRate collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListCurrencyExchangeRatesQueries | No | Queries to be sent with the request |
Returns: ListCurrencyExchangeRatesResponse|error
Sample code:
ListCurrencyExchangeRatesResponse result = check client->listCurrencyExchangeRates();
Sample response:
{
"d": {
"results": [
{
"effectiveStartDate": "2026-01-01",
"externalCode": "1000"
}
]
}
}
createCurrencyExchangeRate
Creates a new CurrencyExchangeRate entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | CurrencyExchangeRate | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedCurrencyExchangeRate|error
Sample code:
CreatedCurrencyExchangeRate result = check client->createCurrencyExchangeRate(payload);
Sample response:
{
"d": {
"effectiveStartDate": "2026-01-01",
"externalCode": "1000"
}
}
getCurrencyExchangeRate
Retrieves a single CurrencyExchangeRate entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
effectiveStartDate | string | Yes | key: effectiveStartDate |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetCurrencyExchangeRateQueries | No | Queries to be sent with the request |
Returns: CurrencyExchangeRate_1|error
Sample code:
CurrencyExchangeRate_1 result = check client->getCurrencyExchangeRate(effectiveStartDate, externalCode);
Sample response:
{
"d": {
"effectiveStartDate": "2026-01-01",
"externalCode": "1000"
}
}
updateCurrencyExchangeRate
Updates the CurrencyExchangeRate identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
effectiveStartDate | string | Yes | key: effectiveStartDate |
externalCode | string | Yes | key: externalCode |
payload | ModifiedCurrencyExchangeRate | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateCurrencyExchangeRate(effectiveStartDate, externalCode, payload);
deleteCurrencyExchangeRate
Deletes the CurrencyExchangeRate identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
effectiveStartDate | string | Yes | key: effectiveStartDate |
externalCode | string | Yes | key: externalCode |
headers | DeleteCurrencyExchangeRateHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteCurrencyExchangeRate(effectiveStartDate, externalCode);
NonRecurringPayment
listNonRecurringPayments
Queries the NonRecurringPayment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListNonRecurringPaymentsQueries | No | Queries to be sent with the request |
Returns: ListNonRecurringPaymentsResponse|error
Sample code:
ListNonRecurringPaymentsResponse result = check client->listNonRecurringPayments();
Sample response:
{
"d": {
"results": [
{
"externalCode": "1000"
}
]
}
}
getNonRecurringPayment
Retrieves a single NonRecurringPayment entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetNonRecurringPaymentQueries | No | Queries to be sent with the request |
Returns: NonRecurringPayment_1|error
Sample code:
NonRecurringPayment_1 result = check client->getNonRecurringPayment(externalCode);
Sample response:
{
"d": {
"externalCode": "1000"
}
}
EducationDegreeEntity
listEducationDegreeEntities
Queries the EducationDegreeEntity collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEducationDegreeEntitiesQueries | No | Queries to be sent with the request |
Returns: ListEducationDegreeEntitiesResponse|error
Sample code:
ListEducationDegreeEntitiesResponse result = check client->listEducationDegreeEntities();
Sample response:
{
"d": {
"results": [
{
"externalCode": "1000"
}
]
}
}
createEducationDegreeEntity
Creates a new EducationDegreeEntity entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EducationDegreeEntity | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEducationDegreeEntity|error
Sample code:
CreatedEducationDegreeEntity result = check client->createEducationDegreeEntity(payload);
Sample response:
{
"d": {
"externalCode": "1000"
}
}
getEducationDegreeEntity
Retrieves a single EducationDegreeEntity entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEducationDegreeEntityQueries | No | Queries to be sent with the request |
Returns: EducationDegreeEntity_1|error
Sample code:
EducationDegreeEntity_1 result = check client->getEducationDegreeEntity(externalCode);
Sample response:
{
"d": {
"externalCode": "1000"
}
}
updateEducationDegreeEntity
Updates the EducationDegreeEntity identified by its key property with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
payload | ModifiedEducationDegreeEntity | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEducationDegreeEntity(externalCode, payload);
deleteEducationDegreeEntity
Deletes the EducationDegreeEntity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | DeleteEducationDegreeEntityHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEducationDegreeEntity(externalCode);
ServiceDeskContactSupportInformation
listServiceDeskContactSupportInformations
Queries the ServiceDeskContactSupportInformation collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListServiceDeskContactSupportInformationsQueries | No | Queries to be sent with the request |
Returns: ListServiceDeskContactSupportInformationsResponse|error
Sample code:
ListServiceDeskContactSupportInformationsResponse result = check client->listServiceDeskContactSupportInformations();
Sample response:
{
"d": {
"results": [
{
"externalCode": "1000",
"serviceDeskCountrySupportInformation": {}
}
]
}
}
createServiceDeskContactSupportInformation
Creates a new ServiceDeskContactSupportInformation entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | ServiceDeskContactSupportInformation | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedServiceDeskContactSupportInformation|error
Sample code:
CreatedServiceDeskContactSupportInformation result = check client->createServiceDeskContactSupportInformation(payload);
Sample response:
{
"d": {
"externalCode": "1000",
"serviceDeskCountrySupportInformation": {
"results": []
}
}
}
getServiceDeskContactSupportInformation
Retrieves a single ServiceDeskContactSupportInformation entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetServiceDeskContactSupportInformationQueries | No | Queries to be sent with the request |
Returns: ServiceDeskContactSupportInformation_1|error
Sample code:
ServiceDeskContactSupportInformation_1 result = check client->getServiceDeskContactSupportInformation(externalCode);
Sample response:
{
"d": {
"externalCode": "1000",
"serviceDeskCountrySupportInformation": {
"results": []
}
}
}
updateServiceDeskContactSupportInformation
Updates the ServiceDeskContactSupportInformation identified by its key property with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | int | Yes | key: externalCode |
payload | ModifiedServiceDeskContactSupportInformation | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateServiceDeskContactSupportInformation(externalCode, payload);
deleteServiceDeskContactSupportInformation
Deletes the ServiceDeskContactSupportInformation identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | int | Yes | key: externalCode |
headers | DeleteServiceDeskContactSupportInformationHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteServiceDeskContactSupportInformation(externalCode);
PerGlobalInfoBRA
listPerGlobalInfoBRAs
Queries the PerGlobalInfoBRA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoBRAsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoBRAsResponse|error
Sample code:
ListPerGlobalInfoBRAsResponse result = check client->listPerGlobalInfoBRAs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoBRA
Retrieves a single PerGlobalInfoBRA entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoBRAQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoBRA_1|error
Sample code:
PerGlobalInfoBRA_1 result = check client->getPerGlobalInfoBRA(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoCHE
listPerGlobalInfoCHEs
Queries the PerGlobalInfoCHE collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoCHEsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoCHEsResponse|error
Sample code:
ListPerGlobalInfoCHEsResponse result = check client->listPerGlobalInfoCHEs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoCHE
Retrieves a single PerGlobalInfoCHE entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoCHEQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoCHE_1|error
Sample code:
PerGlobalInfoCHE_1 result = check client->getPerGlobalInfoCHE(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoGBR
listPerGlobalInfoGBRs
Queries the PerGlobalInfoGBR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoGBRsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoGBRsResponse|error
Sample code:
ListPerGlobalInfoGBRsResponse result = check client->listPerGlobalInfoGBRs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoGBR
Retrieves a single PerGlobalInfoGBR entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoGBRQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoGBR_1|error
Sample code:
PerGlobalInfoGBR_1 result = check client->getPerGlobalInfoGBR(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoAUS
listPerGlobalInfoAUSs
Queries the PerGlobalInfoAUS collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoAUSsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoAUSsResponse|error
Sample code:
ListPerGlobalInfoAUSsResponse result = check client->listPerGlobalInfoAUSs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoAUS
Retrieves a single PerGlobalInfoAUS entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoAUSQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoAUS_1|error
Sample code:
PerGlobalInfoAUS_1 result = check client->getPerGlobalInfoAUS(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoESP
listPerGlobalInfoESPs
Queries the PerGlobalInfoESP collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoESPsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoESPsResponse|error
Sample code:
ListPerGlobalInfoESPsResponse result = check client->listPerGlobalInfoESPs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoESP
Retrieves a single PerGlobalInfoESP entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoESPQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoESP_1|error
Sample code:
PerGlobalInfoESP_1 result = check client->getPerGlobalInfoESP(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
EducationMajorEntity
listEducationMajorEntities
Queries the EducationMajorEntity collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEducationMajorEntitiesQueries | No | Queries to be sent with the request |
Returns: ListEducationMajorEntitiesResponse|error
Sample code:
ListEducationMajorEntitiesResponse result = check client->listEducationMajorEntities();
Sample response:
{
"d": {
"results": [
{
"externalCode": "1000"
}
]
}
}
createEducationMajorEntity
Creates a new EducationMajorEntity entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EducationMajorEntity | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEducationMajorEntity|error
Sample code:
CreatedEducationMajorEntity result = check client->createEducationMajorEntity(payload);
Sample response:
{
"d": {
"externalCode": "1000"
}
}
getEducationMajorEntity
Retrieves a single EducationMajorEntity entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEducationMajorEntityQueries | No | Queries to be sent with the request |
Returns: EducationMajorEntity_1|error
Sample code:
EducationMajorEntity_1 result = check client->getEducationMajorEntity(externalCode);
Sample response:
{
"d": {
"externalCode": "1000"
}
}
updateEducationMajorEntity
Updates the EducationMajorEntity identified by its key property with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
payload | ModifiedEducationMajorEntity | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEducationMajorEntity(externalCode, payload);
deleteEducationMajorEntity
Deletes the EducationMajorEntity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | DeleteEducationMajorEntityHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEducationMajorEntity(externalCode);
PerGlobalInfoCAN
listPerGlobalInfoCANs
Queries the PerGlobalInfoCAN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoCANsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoCANsResponse|error
Sample code:
ListPerGlobalInfoCANsResponse result = check client->listPerGlobalInfoCANs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoCAN
Retrieves a single PerGlobalInfoCAN entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoCANQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoCAN_1|error
Sample code:
PerGlobalInfoCAN_1 result = check client->getPerGlobalInfoCAN(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoUSA
listPerGlobalInfoUSAs
Queries the PerGlobalInfoUSA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoUSAsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoUSAsResponse|error
Sample code:
ListPerGlobalInfoUSAsResponse result = check client->listPerGlobalInfoUSAs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoUSA
Retrieves a single PerGlobalInfoUSA entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoUSAQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoUSA_1|error
Sample code:
PerGlobalInfoUSA_1 result = check client->getPerGlobalInfoUSA(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
ServiceDeskCountrySupportInformation
listServiceDeskCountrySupportInformations
Queries the ServiceDeskCountrySupportInformation collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListServiceDeskCountrySupportInformationsQueries | No | Queries to be sent with the request |
Returns: ListServiceDeskCountrySupportInformationsResponse|error
Sample code:
ListServiceDeskCountrySupportInformationsResponse result = check client->listServiceDeskCountrySupportInformations();
Sample response:
{
"d": {
"results": [
{
"ServiceDeskContactSupportInformation_externalCode": "1000",
"externalCode": "1000"
}
]
}
}
createServiceDeskCountrySupportInformation
Creates a new ServiceDeskCountrySupportInformation entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | ServiceDeskCountrySupportInformation | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedServiceDeskCountrySupportInformation|error
Sample code:
CreatedServiceDeskCountrySupportInformation result = check client->createServiceDeskCountrySupportInformation(payload);
Sample response:
{
"d": {
"ServiceDeskContactSupportInformation_externalCode": "1000",
"externalCode": "1000"
}
}
getServiceDeskCountrySupportInformation
Retrieves a single ServiceDeskCountrySupportInformation entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
ServiceDeskContactSupportInformation_externalCode | int | Yes | key: ServiceDeskContactSupportInformation_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetServiceDeskCountrySupportInformationQueries | No | Queries to be sent with the request |
Returns: ServiceDeskCountrySupportInformation_1|error
Sample code:
ServiceDeskCountrySupportInformation_1 result = check client->getServiceDeskCountrySupportInformation(ServiceDeskContactSupportInformation_externalCode, externalCode);
Sample response:
{
"d": {
"ServiceDeskContactSupportInformation_externalCode": "1000",
"externalCode": "1000"
}
}
updateServiceDeskCountrySupportInformation
Updates the ServiceDeskCountrySupportInformation identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
ServiceDeskContactSupportInformation_externalCode | int | Yes | key: ServiceDeskContactSupportInformation_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedServiceDeskCountrySupportInformation | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateServiceDeskCountrySupportInformation(ServiceDeskContactSupportInformation_externalCode, externalCode, payload);
deleteServiceDeskCountrySupportInformation
Deletes the ServiceDeskCountrySupportInformation identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
ServiceDeskContactSupportInformation_externalCode | int | Yes | key: ServiceDeskContactSupportInformation_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteServiceDeskCountrySupportInformationHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteServiceDeskCountrySupportInformation(ServiceDeskContactSupportInformation_externalCode, externalCode);
EducationMajorContent
listEducationMajorContents
Queries the EducationMajorContent collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEducationMajorContentsQueries | No | Queries to be sent with the request |
Returns: ListEducationMajorContentsResponse|error
Sample code:
ListEducationMajorContentsResponse result = check client->listEducationMajorContents();
Sample response:
{
"d": {
"results": [
{
"JobProfile_externalCode": "1000",
"externalCode": "1000",
"entityNav": {},
"mappedDegreeIdNav": {}
}
]
}
}
createEducationMajorContent
Creates a new EducationMajorContent entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EducationMajorContent | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEducationMajorContent|error
Sample code:
CreatedEducationMajorContent result = check client->createEducationMajorContent(payload);
Sample response:
{
"d": {
"JobProfile_externalCode": "1000",
"externalCode": "1000",
"entityNav": {
"externalCode": "1000"
},
"mappedDegreeIdNav": {
"externalCode": "1000"
}
}
}
getEducationMajorContent
Retrieves a single EducationMajorContent entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
JobProfile_externalCode | string | Yes | key: JobProfile_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEducationMajorContentQueries | No | Queries to be sent with the request |
Returns: EducationMajorContent_1|error
Sample code:
EducationMajorContent_1 result = check client->getEducationMajorContent(JobProfile_externalCode, externalCode);
Sample response:
{
"d": {
"JobProfile_externalCode": "1000",
"externalCode": "1000",
"entityNav": {
"externalCode": "1000"
},
"mappedDegreeIdNav": {
"externalCode": "1000"
}
}
}
updateEducationMajorContent
Updates the EducationMajorContent identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
JobProfile_externalCode | string | Yes | key: JobProfile_externalCode |
externalCode | string | Yes | key: externalCode |
payload | ModifiedEducationMajorContent | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEducationMajorContent(JobProfile_externalCode, externalCode, payload);
deleteEducationMajorContent
Deletes the EducationMajorContent identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
JobProfile_externalCode | string | Yes | key: JobProfile_externalCode |
externalCode | string | Yes | key: externalCode |
headers | DeleteEducationMajorContentHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEducationMajorContent(JobProfile_externalCode, externalCode);
PerGlobalInfoFRA
listPerGlobalInfoFRAs
Queries the PerGlobalInfoFRA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoFRAsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoFRAsResponse|error
Sample code:
ListPerGlobalInfoFRAsResponse result = check client->listPerGlobalInfoFRAs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoFRA
Retrieves a single PerGlobalInfoFRA entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoFRAQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoFRA_1|error
Sample code:
PerGlobalInfoFRA_1 result = check client->getPerGlobalInfoFRA(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoDEU
listPerGlobalInfoDEUs
Queries the PerGlobalInfoDEU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoDEUsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoDEUsResponse|error
Sample code:
ListPerGlobalInfoDEUsResponse result = check client->listPerGlobalInfoDEUs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoDEU
Retrieves a single PerGlobalInfoDEU entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoDEUQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoDEU_1|error
Sample code:
PerGlobalInfoDEU_1 result = check client->getPerGlobalInfoDEU(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoDNK
listPerGlobalInfoDNKs
Queries the PerGlobalInfoDNK collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoDNKsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoDNKsResponse|error
Sample code:
ListPerGlobalInfoDNKsResponse result = check client->listPerGlobalInfoDNKs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoDNK
Retrieves a single PerGlobalInfoDNK entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoDNKQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoDNK_1|error
Sample code:
PerGlobalInfoDNK_1 result = check client->getPerGlobalInfoDNK(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoITA
listPerGlobalInfoITAs
Queries the PerGlobalInfoITA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoITAsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoITAsResponse|error
Sample code:
ListPerGlobalInfoITAsResponse result = check client->listPerGlobalInfoITAs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoITA
Retrieves a single PerGlobalInfoITA entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoITAQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoITA_1|error
Sample code:
PerGlobalInfoITA_1 result = check client->getPerGlobalInfoITA(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoNLD
listPerGlobalInfoNLDs
Queries the PerGlobalInfoNLD collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoNLDsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoNLDsResponse|error
Sample code:
ListPerGlobalInfoNLDsResponse result = check client->listPerGlobalInfoNLDs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoNLD
Retrieves a single PerGlobalInfoNLD entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoNLDQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoNLD_1|error
Sample code:
PerGlobalInfoNLD_1 result = check client->getPerGlobalInfoNLD(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoPRT
listPerGlobalInfoPRTs
Queries the PerGlobalInfoPRT collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoPRTsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoPRTsResponse|error
Sample code:
ListPerGlobalInfoPRTsResponse result = check client->listPerGlobalInfoPRTs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoPRT
Retrieves a single PerGlobalInfoPRT entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoPRTQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoPRT_1|error
Sample code:
PerGlobalInfoPRT_1 result = check client->getPerGlobalInfoPRT(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoQAT
listPerGlobalInfoQATs
Queries the PerGlobalInfoQAT collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoQATsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoQATsResponse|error
Sample code:
ListPerGlobalInfoQATsResponse result = check client->listPerGlobalInfoQATs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoQAT
Retrieves a single PerGlobalInfoQAT entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoQATQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoQAT_1|error
Sample code:
PerGlobalInfoQAT_1 result = check client->getPerGlobalInfoQAT(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoSAU
listPerGlobalInfoSAUs
Queries the PerGlobalInfoSAU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoSAUsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoSAUsResponse|error
Sample code:
ListPerGlobalInfoSAUsResponse result = check client->listPerGlobalInfoSAUs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoSAU
Retrieves a single PerGlobalInfoSAU entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoSAUQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoSAU_1|error
Sample code:
PerGlobalInfoSAU_1 result = check client->getPerGlobalInfoSAU(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
PerGlobalInfoZAF
listPerGlobalInfoZAFs
Queries the PerGlobalInfoZAF collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPerGlobalInfoZAFsQueries | No | Queries to be sent with the request |
Returns: ListPerGlobalInfoZAFsResponse|error
Sample code:
ListPerGlobalInfoZAFsResponse result = check client->listPerGlobalInfoZAFs();
Sample response:
{
"d": {
"results": [
{
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
]
}
}
getPerGlobalInfoZAF
Retrieves a single PerGlobalInfoZAF entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
country | string | Yes | key: country |
personIdExternal | string | Yes | key: personIdExternal |
startDate | string | Yes | key: startDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPerGlobalInfoZAFQueries | No | Queries to be sent with the request |
Returns: PerGlobalInfoZAF_1|error
Sample code:
PerGlobalInfoZAF_1 result = check client->getPerGlobalInfoZAF(country, personIdExternal, startDate);
Sample response:
{
"d": {
"country": "string",
"personIdExternal": "1000",
"startDate": "2026-01-01"
}
}
GetBizXAction
getGetBizXAction
Retrieves a single GetBizXAction entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetGetBizXActionQueries | No | Queries to be sent with the request |
Returns: Result|error
Sample code:
Result result = check client->getGetBizXAction();
Sample response:
{
"d": {
"results": [
{}
]
}
}