Inbound Service QueryEmployeeIn
Overview
| Description | Query Employees |
| Name | QueryEmployeeIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Business Partner Data Management |
| Process Component Name | BusinessPartnerDataManagement |
| Process Component Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
| Deploymnent Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component |
Operations | Find employees basic data using identification data
Find employees biographical data using identification data
Find employees data using organisational ID
|
Public Solution Model
Documentation
Definition
An interface to query employee master data.
Business Context and Use
The web service interface Query Employee In enables you to connect external applications to your solution and to query and read employees in your system. The web service interface Query Employee In is relevant if your company wants to access and manage business partner data from external applications.
The web service interface QueryEmployeeIn offers the operations FindBasicDataByIdentification, FindBiographicalDataByIdentification and FindDataByOrganisationalID.
Here is an example of a simple web service request:
<n0:EmployeeDataByIdentificationQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<EmployeeDataSelectionByIdentification>
<SelectionByEmployeeID>
<InclusionExclusionCode>I</InclusionExclusionCode>
<IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
<LowerBoundaryEmployeeID>E00*</LowerBoundaryEmployeeID>
<UpperBoundaryEmployeeID></UpperBoundaryEmployeeID>
</SelectionByEmployeeID>
</EmployeeDataSelectionByIdentification>
<PROCESSING_CONDITIONS>
<QueryHitsMaximumNumberValue>5</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
<LastReturnedObjectID></LastReturnedObjectID>
</PROCESSING_CONDITIONS>
</n0:EmployeeDataByIdentificationQuery_sync>
Constraints and Integrity Conditions
General Rules for Using this Web Service
Requested Elements
| The 'Requested Elements' functionality will only be supported by the operations FindBasicDataByIdentification and FindDataByOrganisationalID.
|
More Information
General Information
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Scenarios
The following example scenario can be carried out using requested elements.
All employees are searched for that have the family name "Meier". However only the node "Common" that is valid on system date is returned.
<n0:EmployeeBiographicalDataByIdentificationQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<EmployeeBiographicalDataSelectionByIdentification>
<SelectionByEmployeeFamilyName>
<InclusionExclusionCode>I</InclusionExclusionCode>
<IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
<LowerBoundaryName>Meier</LowerBoundaryName>
</SelectionByEmployeeFamilyName>
</EmployeeBiographicalDataSelectionByIdentification>
<ProcessingConditions>
<QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
</n0:EmployeeBiographicalDataByIdentificationQuery_sync>
Operation Find Basic Data By Identification
Overview
| Description | Find employees basic data using identification data |
| Name | FindBasicDataByIdentification |
| Synchronous | yes |
Public Solution Model
Documentation
Definition
To find employee basic data by identification.
Business Context and Use
The request message of the operation FindBasicByIdentification contains the EmployeeBasicDataSelectionByIdentification node that groups all possible selection parameters.
Structure
Request
Employee Basic Data Selection By Identification
This node groups all selection parameters. The selection parameters are:
| Selection Parameter |
Remark |
|---|
| SelectionByEmployeeID |
Selection by employee ID |
| SelectionByEmployeeFamilyName |
Selection by employee family name |
| SelectionByEmployeeGivenName |
Selection by employee given name |
| SelectionByCreatedSinceDate |
Selection by created since date |
| SelectionByCreationIdentityID |
Selection by creation identity ID |
| SelectionByChangedSinceDate |
Selection by changed since date |
| SelectionByLastChangeIdentityID |
Selection by last change identity ID |
| SelectionBySearchText |
Selection by search text (basic search) |
Response
The response message contains the list of the found employees' biographical data, workplace address data, job assignment, employee organizational assignment, log items, and processing conditions.
Employee
In this node, all found employees are contained, including the most important fields (for example UUID, EmployeeID, SystemAdministrationData). In addition the ChangeStateID may be needed for subsequent change requests via web services as well.
Biographical Data
This node contains the most important fields of COMMON node (for example, FormOfAddress, FamiliyName, and GivenName).
Furthermore all customer fields, which have been added to node COMMON of BO Employee, are returned.
Workplace Address Information data
This node contains the most important fields of the EmployeeWorkplaceAddress (for instance Country, Street, Phone, MobilePhone, Fax, E-Mail, etc.).
Job Assignment data
This node contains the most important fields of the Job Assignment of an Employee (JobID, JobUUID, JobName, RoleCode and ValidityPeriod).
Employee organizational Assignment data
This node contains the most important fields of the CurrentOrganisationalUnitAssignment of an Employee (OrganisationalCentreID, RoleCode and ValidityPeriod).
Operation Find Biographical Data By Identification
Overview
| Description | Find employees biographical data using identification data |
| Name | FindBiographicalDataByIdentification |
| Synchronous | yes |
Public Solution Model
Documentation
Definition
To find employee biographical data by identification ("Common" node that is valid on system date).
Business Context and Use
The request message of the operation FindBiogByIdentification contains the EmployeeBiographicalDataSelectionByIdentification node that groups all possible selection parameters.
Structure
Request
Employee Biographical Data Selection By Identification
This node groups all selection parameters. The selection parameters are:
| Selection Parameter |
Remark |
|---|
| SelectionByEmployeeID |
Selection by employee ID |
| SelectionByEmployeeFamilyName |
Selection by employee family name |
| SelectionByEmployeeGivenName |
Selection by employee given name |
| SelectionByCreatedSinceDate |
Selection by created since date |
| SelectionByCreationIdentityID |
Selection by creation identity ID |
| SelectionByChangedSinceDate |
Selection by changed since date |
| SelectionByLastChangeIdentityID |
Selection by last change identity ID |
| SelectionBySearchText |
Selection by search text (basic search) |
Response
The response message contains the list of the found employee`s biographical data (Common instance node that is valid on system date), log items, and processing conditions.
Biographical data
This node contains all found employees including the most important fields of the COMMON node (FormOfAddress, FamiliyName, GivenName, etc.). Note that only the COMMON instance valid on system date will be returned. In addition the UUID, the EmployeeID and the ChangeStateID that may be needed for subsequent changes are also returned via web service.
Furthermore all customer fields that have been added to the COMMON node of the BO Employee will be returned.
Operation Find Data By Organisational ID
Overview
| Description | Find employees data using organisational ID |
| Name | FindDataByOrganisationalID |
| Synchronous | yes |
Public Solution Model
Documentation
Definition
To find employee data by Organisational ID.
Business Context and Use
The request message of the operation FindByOrganisationalID contains the EmployeeDataSelectionByOrganisationalID node that groups all possible selection parameters.
Structure
Request
Employee Basic Data Selection By Identification
This node groups all selection parameters. The selection parameters are:
| Selection Parameter |
Remark |
|---|
| SelectionByOrgCentreID |
Selection by organizational centre ID |
Response
The response message contains the list of the found employee's (assigned on system date to given Organizational Centers) biographical data, workplace address data, job assignment, log items, and processing conditions.
Employee
In this node, all found employees are contained, including the most important fields (for example UUID, EmployeeID, Organizational ID, SystemAdministrationData). In addition the ChangeStateID may be needed for subsequent change requests via web services as well.
Biographical Data
This node contains the most important fields of COMMON node (for example, FormOfAddress, FamiliyName, and GivenName).
Furthermore all customer fields, which have been added to node COMMON of BO Employee, are returned.
Workplace Address Information data
This node contains the most important fields of the EmployeeWorkplaceAddress (for instance Country, Street, Phone, MobilePhone, Fax, E-Mail, etc.).
Job Assignment data
This node contains the most important fields of the Job Assignment of an Employee (JobID, JobUUID, JobName, RoleCode and ValidityPeriod).
Employee organizational Assignment data
This node contains the most important fields of the CurrentOrganisationalUnitAssignment of an Employee (OrganisationalCentreID, RoleCode and ValidityPeriod).
Show full documentation
Show full documentation