This KBA explains the various properties returned in the Compound Employee API Delta Transmission query response and what significance each carries.
Successfactors Compound Employee API
Here's what the query response of the Compound Employee API call looks like.
The query response has the following properties:
- sfobject: List of employees with sub-entities, returned as hierarchical XML
- numResult: Number of top-level results
- hasMore: Indicator if more results are available
- querySessionId: Query session ID for paging
The query response follows the current Employee Central data model by building a hierarchically structured XML. The names of the sub-structures are derived from the underlying database tables and SAP SuccessFactors entity names. The leaf elements below are named according to HRIS field metadata (HRIS-field id or HRIS-field name) or MDF object instance name.
The Compound Employee API returns employees (persons with employment) only. Persons without employment are excluded from extraction and not returned. This means that technical users (admin users) and employee dependents are not returned as sfobject by the API. But dependents are considered as a sub-element of employees.
NOTE: In addition to above, the query response of Compound Employee API has some specifics regarding effective-dated and period-based delta transmission also.
hasMore, numResult, sfobject, querySessionId, Compound Employee, query response, response parameters/properties, delta transmission , KBA , LOD-SF-INT-CE , Compound Employee API , LOD-SF-INT , SF Integrations - EC Payroll, Boomi/ HCI, API , How To