SAP Knowledge Base Article - Public

2891030 - Extracting Work Permit Information / Info using SFAPI CompoundEmployee - SuccessFactors HXM Suite

Symptom

You would like to extract the Work permit information / Info portlet from your SuccessFactors Employee Central using APIs.

Environment

  • SuccessFactors HXM Suite
    • SFAPI CompoundEmployee

Resolution

Work permit information is included in segment personal_documents_information.

You can build one query asking for this segment using SFAPI CompoundEmployee (SOAP API call), find below one example of request from SalesDemo instance.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<query xmlns="urn:sfobject.sfapi.successfactors.com">
<queryString>
    SELECT person,employment_information,personal_documents_information
      FROM CompoundEmployee
      WHERE user_id IN ('ChenM')
</queryString>
</query>
</Body>
</Envelope>

In the SFAPI CE response, you will see segments stored under the <employment_information> like example below:

<personal_documents_information>
<country>SGP</country>
<created_by>sfadmin</created_by>
<created_on_timestamp>2016-06-22T17:10:16.000Z</created_on_timestamp>
<document_number>243423233</document_number>
<document_title>Passport</document_title>
<document_type>4</document_type>
<expiration_date>2020-06-23</expiration_date>
<is_validated>true</is_validated>
<issue_date>2012-06-07</issue_date>
<issue_place>Singapore</issue_place>
<issuing_authority>ICA</issuing_authority>
<last_modified_by>sfadmin</last_modified_by>
<last_modified_on>2018-12-14T18:07:57.000Z</last_modified_on>
</personal_documents_information>

Keywords

extract the Work permit information / Info portlet from your SuccessFactors Employee Central using APIs, extracting, API, CompoundEmployee, CE, SFAPI, download, retrieve, <personal_documents_information> , KBA , LOD-SF-INT , Integrations , LOD-SF-INT-CE , Compound Employee API , How To

Product

SAP SuccessFactors HXM Suite all versions