Actions

The ballerinax/sap.successfactors.ecpersonalinformation package exposes the following clients:

Available clients:

Client	Purpose
`Client`	Manages ecpersonalinformation objects: PerEmergencyContacts, PerPhone, PersonKey, PerPersonal, PerSocialAccount, PerPerson, PerPersonRelationship, PerEmail…, over the SAP SuccessFactors OData v2 API.

Client

You can use these APIs to access the personal information of an employee including emergency contact information, social media accounts, email address, and non-effective-dated biographical information such as date of birth, country of birth and national identification card information.

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.ecpersonalinformation;

configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

ecpersonalinformation:Client client = check new (
    {
        auth: { username, password }
    },
    hostname
);

Operations

PerEmergencyContacts

listPerEmergencyContactss

Queries the PerEmergencyContacts 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`	`ListPerEmergencyContactssQueries`	No	Queries to be sent with the request

Returns: ListPerEmergencyContactssResponse|error

Sample code:

ListPerEmergencyContactssResponse result = check client->listPerEmergencyContactss();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerEmergencyContacts

Retrieves a single PerEmergencyContacts entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`name`	`string`	Yes	key: name
`personIdExternal`	`string`	Yes	key: personIdExternal
`relationship`	`string`	Yes	key: relationship
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerEmergencyContactsQueries`	No	Queries to be sent with the request

Returns: PerEmergencyContacts|error

Sample code:

PerEmergencyContacts result = check client->getPerEmergencyContacts(name, personIdExternal, relationship);

Sample response:

{
  "d": {}
}

PerPhone

listPerPhones

Queries the PerPhone 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`	`ListPerPhonesQueries`	No	Queries to be sent with the request

Returns: ListPerPhonesResponse|error

Sample code:

ListPerPhonesResponse result = check client->listPerPhones();

Sample response:

{
  "d": {
    "results": [
      {
        "personIdExternal": "1000",
        "phoneType": "string",
        "personNav": {}
      }
    ]
  }
}

getPerPhone

Retrieves a single PerPhone entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`personIdExternal`	`string`	Yes	key: personIdExternal
`phoneType`	`string`	Yes	key: phoneType
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerPhoneQueries`	No	Queries to be sent with the request

Returns: PerPhone|error

Sample code:

PerPhone result = check client->getPerPhone(personIdExternal, phoneType);

Sample response:

{
  "personIdExternal": "1000",
  "phoneType": "string",
  "personNav": {
    "personIdExternal": "1000",
    "emailNav": {
      "results": []
    },
    "emergencyContactNav": {
      "results": []
    },
    "homeAddressNavDEFLT": {
      "results": []
    },
    "nationalIdNav": {
      "results": []
    },
    "personRerlationshipNav": {
      "results": []
    },
    "personalInfoNav": {
      "results": []
    },
    "phoneNav": {
      "results": []
    },
    "socialAccountNav": {
      "results": []
    }
  }
}

PersonKey

listPersonKeys

Queries the PersonKey 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`	`ListPersonKeysQueries`	No	Queries to be sent with the request

Returns: ListPersonKeysResponse|error

Sample code:

ListPersonKeysResponse result = check client->listPersonKeys();

Sample response:

{
  "d": {
    "results": [
      {
        "personIdExternal": "1000"
      }
    ]
  }
}

getPersonKey

Retrieves a single PersonKey entity identified by its key property.

Parameters:

Name	Type	Required	Description
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPersonKeyQueries`	No	Queries to be sent with the request

Returns: PersonKey|error

Sample code:

PersonKey result = check client->getPersonKey(personIdExternal);

Sample response:

{
  "personIdExternal": "1000"
}

PerPersonal

listPerPersonals

Queries the PerPersonal 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`	`ListPerPersonalsQueries`	No	Queries to be sent with the request

Returns: ListPerPersonalsResponse|error

Sample code:

ListPerPersonalsResponse result = check client->listPerPersonals();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerPersonal

Retrieves a single PerPersonal entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`personIdExternal`	`string`	Yes	key: personIdExternal
`startDate`	`string`	Yes	key: startDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerPersonalQueries`	No	Queries to be sent with the request

Returns: PerPersonal|error

Sample code:

PerPersonal result = check client->getPerPersonal(personIdExternal, startDate);

Sample response:

{
  "d": {}
}

PerSocialAccount

listPerSocialAccounts

Queries the PerSocialAccount 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`	`ListPerSocialAccountsQueries`	No	Queries to be sent with the request

Returns: ListPerSocialAccountsResponse|error

Sample code:

ListPerSocialAccountsResponse result = check client->listPerSocialAccounts();

Sample response:

{
  "d": {
    "results": [
      {
        "domain": "string",
        "personIdExternal": "1000",
        "personNav": {}
      }
    ]
  }
}

getPerSocialAccount

Retrieves a single PerSocialAccount entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`domain`	`string`	Yes	key: domain
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerSocialAccountQueries`	No	Queries to be sent with the request

Returns: PerSocialAccount|error

Sample code:

PerSocialAccount result = check client->getPerSocialAccount(domain, personIdExternal);

Sample response:

{
  "domain": "string",
  "personIdExternal": "1000",
  "personNav": {
    "personIdExternal": "1000",
    "emailNav": {
      "results": []
    },
    "emergencyContactNav": {
      "results": []
    },
    "homeAddressNavDEFLT": {
      "results": []
    },
    "nationalIdNav": {
      "results": []
    },
    "personRerlationshipNav": {
      "results": []
    },
    "personalInfoNav": {
      "results": []
    },
    "phoneNav": {
      "results": []
    },
    "socialAccountNav": {
      "results": []
    }
  }
}

PerPerson

listPerPersons

Queries the PerPerson 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`	`ListPerPersonsQueries`	No	Queries to be sent with the request

Returns: ListPerPersonsResponse|error

Sample code:

ListPerPersonsResponse result = check client->listPerPersons();

Sample response:

{
  "d": {
    "results": [
      {
        "personIdExternal": "1000",
        "emailNav": {},
        "emergencyContactNav": {},
        "homeAddressNavDEFLT": {},
        "nationalIdNav": {},
        "personRerlationshipNav": {},
        "personalInfoNav": {},
        "phoneNav": {},
        "socialAccountNav": {}
      }
    ]
  }
}

getPerPerson

Retrieves a single PerPerson entity identified by its key property.

Parameters:

Name	Type	Required	Description
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerPersonQueries`	No	Queries to be sent with the request

Returns: PerPerson|error

Sample code:

PerPerson result = check client->getPerPerson(personIdExternal);

Sample response:

{
  "personIdExternal": "1000",
  "emailNav": {
    "results": [
      {
        "d": {}
      }
    ]
  },
  "emergencyContactNav": {
    "results": [
      {
        "d": {}
      }
    ]
  },
  "homeAddressNavDEFLT": {
    "results": [
      {
        "d": {}
      }
    ]
  },
  "nationalIdNav": {
    "results": [
      {
        "d": {}
      }
    ]
  },
  "personRerlationshipNav": {
    "results": [
      {
        "d": {}
      }
    ]
  },
  "personalInfoNav": {
    "results": [
      {
        "d": {}
      }
    ]
  },
  "phoneNav": {
    "results": [
      {
        "personIdExternal": "1000",
        "phoneType": "string",
        "personNav": {}
      }
    ]
  },
  "socialAccountNav": {
    "results": [
      {
        "domain": "string",
        "personIdExternal": "1000",
        "personNav": {}
      }
    ]
  }
}

PerPersonRelationship

listPerPersonRelationships

Queries the PerPersonRelationship 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`	`ListPerPersonRelationshipsQueries`	No	Queries to be sent with the request

Returns: ListPerPersonRelationshipsResponse|error

Sample code:

ListPerPersonRelationshipsResponse result = check client->listPerPersonRelationships();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerPersonRelationship

Retrieves a single PerPersonRelationship entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`personIdExternal`	`string`	Yes	key: personIdExternal
`relatedPersonIdExternal`	`string`	Yes	key: relatedPersonIdExternal
`startDate`	`string`	Yes	key: startDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerPersonRelationshipQueries`	No	Queries to be sent with the request

Returns: PerPersonRelationship|error

Sample code:

PerPersonRelationship result = check client->getPerPersonRelationship(personIdExternal, relatedPersonIdExternal, startDate);

Sample response:

{
  "d": {}
}

PerEmail

listPerEmails

Queries the PerEmail 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`	`ListPerEmailsQueries`	No	Queries to be sent with the request

Returns: ListPerEmailsResponse|error

Sample code:

ListPerEmailsResponse result = check client->listPerEmails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerEmail

Retrieves a single PerEmail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`emailType`	`string`	Yes	key: emailType
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerEmailQueries`	No	Queries to be sent with the request

Returns: PerEmail|error

Sample code:

PerEmail result = check client->getPerEmail(emailType, personIdExternal);

Sample response:

{
  "d": {}
}

HrisEmergencyContactAddressDEFLT

listHrisEmergencyContactAddressDEFLTs

Queries the HrisEmergencyContactAddressDEFLT 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`	`ListHrisEmergencyContactAddressDEFLTsQueries`	No	Queries to be sent with the request

Returns: ListHrisEmergencyContactAddressDEFLTsResponse|error

Sample code:

ListHrisEmergencyContactAddressDEFLTsResponse result = check client->listHrisEmergencyContactAddressDEFLTs();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getHrisEmergencyContactAddressDEFLT

Retrieves a single HrisEmergencyContactAddressDEFLT entity identified by its key property.

Parameters:

Name	Type	Required	Description
`addressId`	`string`	Yes	key: addressId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetHrisEmergencyContactAddressDEFLTQueries`	No	Queries to be sent with the request

Returns: HrisEmergencyContactAddressDEFLT|error

Sample code:

HrisEmergencyContactAddressDEFLT result = check client->getHrisEmergencyContactAddressDEFLT(addressId);

Sample response:

{
  "d": {}
}

PerNationalId

listPerNationalIds

Queries the PerNationalId 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`	`ListPerNationalIdsQueries`	No	Queries to be sent with the request

Returns: ListPerNationalIdsResponse|error

Sample code:

ListPerNationalIdsResponse result = check client->listPerNationalIds();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerNationalId

Retrieves a single PerNationalId entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`cardType`	`string`	Yes	key: cardType
`country`	`string`	Yes	key: country
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerNationalIdQueries`	No	Queries to be sent with the request

Returns: PerNationalId|error

Sample code:

PerNationalId result = check client->getPerNationalId(cardType, country, personIdExternal);

Sample response:

{
  "d": {}
}

PerNationalIdWithValidityPeriod

listPerNationalIdWithValidityPeriods

Queries the PerNationalIdWithValidityPeriod 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`	`ListPerNationalIdWithValidityPeriodsQueries`	No	Queries to be sent with the request

Returns: ListPerNationalIdWithValidityPeriodsResponse|error

Sample code:

ListPerNationalIdWithValidityPeriodsResponse result = check client->listPerNationalIdWithValidityPeriods();

Sample response:

{
  "d": {
    "results": [
      {
        "recordId": "1000",
        "validFrom": "1000",
        "validTo": "1000",
        "cardType": "string",
        "country": "string",
        "personIdExternal": "1000",
        "personNav": {}
      }
    ]
  }
}

getPerNationalIdWithValidityPeriod

Retrieves a single PerNationalIdWithValidityPeriod entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`recordId`	`string`	Yes	key: recordId
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerNationalIdWithValidityPeriodQueries`	No	Queries to be sent with the request

Returns: PerNationalIdWithValidityPeriod|error

Sample code:

PerNationalIdWithValidityPeriod result = check client->getPerNationalIdWithValidityPeriod(recordId, personIdExternal);

Sample response:

{
  "recordId": "1000",
  "validFrom": "1000",
  "validTo": "1000",
  "cardType": "string",
  "country": "string",
  "personIdExternal": "1000",
  "personNav": {
    "personIdExternal": "1000",
    "emailNav": {
      "results": []
    },
    "emergencyContactNav": {
      "results": []
    },
    "homeAddressNavDEFLT": {
      "results": []
    },
    "nationalIdNav": {
      "results": []
    },
    "personRerlationshipNav": {
      "results": []
    },
    "personalInfoNav": {
      "results": []
    },
    "phoneNav": {
      "results": []
    },
    "socialAccountNav": {
      "results": []
    }
  }
}

PerAddressDEFLT

listPerAddressDEFLTs

Queries the PerAddressDEFLT 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`	`ListPerAddressDEFLTsQueries`	No	Queries to be sent with the request

Returns: ListPerAddressDEFLTsResponse|error

Sample code:

ListPerAddressDEFLTsResponse result = check client->listPerAddressDEFLTs();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerAddressDEFLT

Retrieves a single PerAddressDEFLT entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`addressType`	`string`	Yes	key: addressType
`personIdExternal`	`string`	Yes	key: personIdExternal
`startDate`	`string`	Yes	key: startDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerAddressDEFLTQueries`	No	Queries to be sent with the request

Returns: PerAddressDEFLT|error

Sample code:

PerAddressDEFLT result = check client->getPerAddressDEFLT(addressType, personIdExternal, startDate);

Sample response:

{
  "d": {}
}

generateNextPersonID

creategenerateNextPersonID

Creates a new generateNextPersonID entity from the supplied payload.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: Result|error

Sample code:

Result result = check client->creategenerateNextPersonID();

Sample response:

{
  "d": {}
}

NameFormatGO

listNameFormatGOs

Queries the NameFormatGO 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`	`ListNameFormatGOsQueries`	No	Queries to be sent with the request

Returns: ListNameFormatGOsResponse|error

Sample code:

ListNameFormatGOsResponse result = check client->listNameFormatGOs();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getNameFormatGO

Retrieves a single NameFormatGO 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`	`GetNameFormatGOQueries`	No	Queries to be sent with the request

Returns: NameFormatGO|error

Sample code:

NameFormatGO result = check client->getNameFormatGO(externalCode);

Sample response:

{
  "d": {}
}

NameElementGO

listNameElementGOs

Queries the NameElementGO 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`	`ListNameElementGOsQueries`	No	Queries to be sent with the request

Returns: ListNameElementGOsResponse|error

Sample code:

ListNameElementGOsResponse result = check client->listNameElementGOs();

Sample response:

{
  "d": {
    "results": [
      {
        "NameFormatGO_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

getNameElementGO

Retrieves a single NameElementGO entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`NameFormatGO_externalCode`	`string`	Yes	key: NameFormatGO_externalCode
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetNameElementGOQueries`	No	Queries to be sent with the request

Returns: NameElementGO|error

Sample code:

NameElementGO result = check client->getNameElementGO(NameFormatGO_externalCode, externalCode);

Sample response:

{
  "NameFormatGO_externalCode": "1000",
  "externalCode": "1000"
}

PerBiographicalInfoLocBRA

listPerBiographicalInfoLocBRAs

Queries the PerBiographicalInfoLocBRA 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`	`ListPerBiographicalInfoLocBRAsQueries`	No	Queries to be sent with the request

Returns: ListPerBiographicalInfoLocBRAsResponse|error

Sample code:

ListPerBiographicalInfoLocBRAsResponse result = check client->listPerBiographicalInfoLocBRAs();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerBiographicalInfoLocBRA

Retrieves a single PerBiographicalInfoLocBRA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`country`	`string`	Yes	key: country
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerBiographicalInfoLocBRAQueries`	No	Queries to be sent with the request

Returns: PerBiographicalInfoLocBRA|error

Sample code:

PerBiographicalInfoLocBRA result = check client->getPerBiographicalInfoLocBRA(country, personIdExternal);

Sample response:

{
  "d": {}
}

PerBiographicalInfoLocCHL

listPerBiographicalInfoLocCHLs

Queries the PerBiographicalInfoLocCHL 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`	`ListPerBiographicalInfoLocCHLsQueries`	No	Queries to be sent with the request

Returns: ListPerBiographicalInfoLocCHLsResponse|error

Sample code:

ListPerBiographicalInfoLocCHLsResponse result = check client->listPerBiographicalInfoLocCHLs();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerBiographicalInfoLocCHL

Retrieves a single PerBiographicalInfoLocCHL entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`country`	`string`	Yes	key: country
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerBiographicalInfoLocCHLQueries`	No	Queries to be sent with the request

Returns: PerBiographicalInfoLocCHL|error

Sample code:

PerBiographicalInfoLocCHL result = check client->getPerBiographicalInfoLocCHL(country, personIdExternal);

Sample response:

{
  "d": {}
}

PerBiographicalInfoLocFRA

listPerBiographicalInfoLocFRAs

Queries the PerBiographicalInfoLocFRA 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`	`ListPerBiographicalInfoLocFRAsQueries`	No	Queries to be sent with the request

Returns: ListPerBiographicalInfoLocFRAsResponse|error

Sample code:

ListPerBiographicalInfoLocFRAsResponse result = check client->listPerBiographicalInfoLocFRAs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "personIdExternal": "1000"
      }
    ]
  }
}

getPerBiographicalInfoLocFRA

Retrieves a single PerBiographicalInfoLocFRA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`country`	`string`	Yes	key: country
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerBiographicalInfoLocFRAQueries`	No	Queries to be sent with the request

Returns: PerBiographicalInfoLocFRA|error

Sample code:

PerBiographicalInfoLocFRA result = check client->getPerBiographicalInfoLocFRA(country, personIdExternal);

Sample response:

{
  "country": "string",
  "personIdExternal": "1000"
}

PerBiographicalInfoLocITA

listPerBiographicalInfoLocITAs

Queries the PerBiographicalInfoLocITA 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`	`ListPerBiographicalInfoLocITAsQueries`	No	Queries to be sent with the request

Returns: ListPerBiographicalInfoLocITAsResponse|error

Sample code:

ListPerBiographicalInfoLocITAsResponse result = check client->listPerBiographicalInfoLocITAs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "personIdExternal": "1000"
      }
    ]
  }
}

getPerBiographicalInfoLocITA

Retrieves a single PerBiographicalInfoLocITA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`country`	`string`	Yes	key: country
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerBiographicalInfoLocITAQueries`	No	Queries to be sent with the request

Returns: PerBiographicalInfoLocITA|error

Sample code:

PerBiographicalInfoLocITA result = check client->getPerBiographicalInfoLocITA(country, personIdExternal);

Sample response:

{
  "country": "string",
  "personIdExternal": "1000"
}

PerBiographicalInfoLocVEN

listPerBiographicalInfoLocVENs

Queries the PerBiographicalInfoLocVEN 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`	`ListPerBiographicalInfoLocVENsQueries`	No	Queries to be sent with the request

Returns: ListPerBiographicalInfoLocVENsResponse|error

Sample code:

ListPerBiographicalInfoLocVENsResponse result = check client->listPerBiographicalInfoLocVENs();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPerBiographicalInfoLocVEN

Retrieves a single PerBiographicalInfoLocVEN entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`country`	`string`	Yes	key: country
`personIdExternal`	`string`	Yes	key: personIdExternal
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPerBiographicalInfoLocVENQueries`	No	Queries to be sent with the request

Returns: PerBiographicalInfoLocVEN|error

Sample code:

PerBiographicalInfoLocVEN result = check client->getPerBiographicalInfoLocVEN(country, personIdExternal);

Sample response:

{
  "d": {}
}

Client​

Configuration​

ConnectionConfig​

Initializing the client​

Operations​

PerEmergencyContacts​

PerPhone​

PersonKey​

PerPersonal​

PerSocialAccount​

PerPerson​

PerPersonRelationship​

PerEmail​

HrisEmergencyContactAddressDEFLT​

PerNationalId​

PerNationalIdWithValidityPeriod​

PerAddressDEFLT​

generateNextPersonID​

NameFormatGO​

NameElementGO​

PerBiographicalInfoLocBRA​

PerBiographicalInfoLocCHL​

PerBiographicalInfoLocFRA​

PerBiographicalInfoLocITA​

PerBiographicalInfoLocVEN​

Client

Configuration

ConnectionConfig

Initializing the client

Operations

PerEmergencyContacts

PerPhone

PersonKey

PerPersonal

PerSocialAccount

PerPerson

PerPersonRelationship

PerEmail

HrisEmergencyContactAddressDEFLT

PerNationalId

PerNationalIdWithValidityPeriod

PerAddressDEFLT

generateNextPersonID

NameFormatGO

NameElementGO

PerBiographicalInfoLocBRA

PerBiographicalInfoLocCHL

PerBiographicalInfoLocFRA

PerBiographicalInfoLocITA

PerBiographicalInfoLocVEN