## 4.2.13.2.1.2  Inbound Service: Business User - Read
Technical name: QUERYBUSINESSUSERIN
This synchronous inbound SOAP service enables you to read users from your external data source such as an identity management system in SAP S/4HANA Cloud.
## Service Request
The service is structured into the following two top-level nodes:
Business User ( BusinessUser )
The service node contains the search parameters.
Nodes and Fields for the BusinessUser Node
| Field or Node               |                           | Description                                                                                                                                                                                                                                                                                                                     | Length   | Cardinality   |
|-----------------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------|
| PersonExternalIDI nterval   | IntervalBoundaryT ypeCode | The following values exist: • 1- Equal No upper boun- dary value must be set. • 3 - Between Upper boundary value is manda- tory. • 6 - Lower than Upper boundary value is • 7 - Lower equal Upper boundary value is • 8 - Greater than Upper boundary value is • 9 - Greater Upper boundary value is This field is mandatory if | 1        | 1             |
| Cardinality: 0..un- bounded |                           | optional. optional. optional. equal optional.                                                                                                                                                                                                                                                                                   |          |               |
|                             | LowerBoundaryPers onExtID | Employee name                                                                                                                                                                                                                                                                                                                   | 60       | 0..1          |
|                             | UpperBoundaryPers onExtID |                                                                                                                                                                                                                                                                                                                                 | 60       | 0..1          |
Maximum Field
| Field or Node                                |                           | Description                                                                                                                                                                                                                                                                                                                                                                                     |   Maximum Field Length | Cardinality   |
|----------------------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| PersonIDInterval Cardinality: 0..un- bounded | IntervalBoundaryT ypeCode | The following values exist: • 1- Equal No upper boun- dary value must be set. • 3 - Between Upper boundary value is manda- tory. • 6 - Lower than Upper boundary value is optional. • 7 - Lower equal Upper boundary value is optional. • 8 - Greater than Upper boundary value is optional. • 9 - Greater equal Upper boundary value is optional. This field is mandatory if LowerBoundaryPers |                      1 | 1             |
|                                              | LowerBoundaryPers onID    |                                                                                                                                                                                                                                                                                                                                                                                                 |                     10 | 0..1          |
|                                              | UpperBoundaryPers onID    |                                                                                                                                                                                                                                                                                                                                                                                                 |                     10 | 0..1          |
| Field or Node                                                |                                            | Description                                                                                                                                                      | Maximum Field Length   | Cardinality   |
|--------------------------------------------------------------|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| BusinessPartnerRo leCodeInterval Cardinality: 0..un- bounded | IntervalBoundaryT ypeCode                  | The following values exist: • 1- Equal No upper boun- dary value must be set. • 3 - Between Upper boundary value is manda- tory. • 6 - Lower than Upper boundary | 1                      | 1             |
| MarkedForArchivin gIndicator Cardinality: 0..un-             | LowerBoundaryBusi nessPartnerRoleCo de     | Only business partner role code BUP003 (Employee) is sup- ported.                                                                                                | 6                      | 0..1          |
| bounded                                                      | IntervalBoundaryT ypeCode                  | The following values exist: • True • False                                                                                                                       |                        | 1             |
|                                                              | LowerBoundaryMark edForArchivingInd icator |                                                                                                                                                                  | 1                      | 0..1          |
| Field or Node                              |                           | Description                                                                                                                                                                                                                                                                                                                                                                                     |   Maximum Field Length | Cardinality   |
|--------------------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| UserIDInterval Cardinality: 0..un- bounded | IntervalBoundaryT ypeCode | The following values exist: • 1- Equal No upper boun- dary value must be set. • 3 - Between Upper boundary value is manda- tory. • 6 - Lower than Upper boundary value is optional. • 7 - Lower equal Upper boundary value is optional. • 8 - Greater than Upper boundary value is optional. • 9 - Greater equal Upper boundary value is optional. This field is mandatory if LowerBoundaryUser |                      1 | 1             |
|                                            | LowerBoundaryUser ID      |                                                                                                                                                                                                                                                                                                                                                                                                 |                     12 | 0..1          |
|                                            | UpperBoundaryUser ID      |                                                                                                                                                                                                                                                                                                                                                                                                 |                     12 | 0..1          |
| Field or Node                                |                           | Description                                                                                                                                                                                                                                                                                                                                                                                     |   Maximum Field Length | Cardinality   |
|----------------------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| UserNameInterval Cardinality: 0..un- bounded | IntervalBoundaryT ypeCode | The following values exist: • 1- Equal No upper boun- dary value must be set. • 3 - Between Upper boundary value is manda- tory. • 6 - Lower than Upper boundary value is optional. • 7 - Lower equal Upper boundary value is optional. • 8 - Greater than Upper boundary value is optional. • 9 - Greater equal Upper boundary value is optional. This field is mandatory if LowerBoundaryUser |                      1 | 1             |
|                                              | LowerBoundaryUser Name    |                                                                                                                                                                                                                                                                                                                                                                                                 |                     40 | 0..1          |
|                                              | UpperBoundaryUser Name    |                                                                                                                                                                                                                                                                                                                                                                                                 |                     40 | 0..1          |
| Field or Node                                 |                           | Description                                                                                                                                                                                                                                                                                                                                                                                     |   Maximum Field Length | Cardinality   |
|-----------------------------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| FirstNameInterval Cardinality: 0..un- bounded | IntervalBoundaryT ypeCode | The following values exist: • 1- Equal No upper boun- dary value must be set. • 3 - Between Upper boundary value is manda- tory. • 6 - Lower than Upper boundary value is optional. • 7 - Lower equal Upper boundary value is optional. • 8 - Greater than Upper boundary value is optional. • 9 - Greater equal Upper boundary value is optional. This field is mandatory if LowerBoundaryFirs |                      1 | 1             |
|                                               | LowerBoundaryFirs tName   |                                                                                                                                                                                                                                                                                                                                                                                                 |                     35 | 0..1          |
|                                               | UpperBoundaryFirs tName   |                                                                                                                                                                                                                                                                                                                                                                                                 |                     35 | 0..1          |
| Field or Node                                |                            | Description                                                                                                                                                                                                                                                                                                                                                                   |   Maximum Field Length | Cardinality   |
|----------------------------------------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| LastNameInterval Cardinality: 0..un- bounded | IntervalBoundaryT ypeCode  | The following values exist: • 1- Equal No upper boun- dary value must be set. • 3 - Between Upper boundary value is manda- tory. • 6 - Lower than Upper boundary value is optional. • 7 - Lower equal Upper boundary value is optional. • 8 - Greater than Upper boundary value is optional. • 9 - Greater equal Upper boundary value is optional. This field is mandatory if |                      1 | 1             |
|                                              | LowerBoundaryLast Name     |                                                                                                                                                                                                                                                                                                                                                                               |                     40 | 0..1          |
|                                              | UpperBoundaryLast Name     |                                                                                                                                                                                                                                                                                                                                                                               |                     40 | 0..1          |
| EmailAddressInter val                        | IntervalBoundaryT ypeCode  |                                                                                                                                                                                                                                                                                                                                                                               |                      1 | 1             |
| Cardinality: 0..un- bounded                  | LowerBoundaryEmai lAddress |                                                                                                                                                                                                                                                                                                                                                                               |                    241 | 0..1          |
|                                              | UpperBoundaryEmai lAddress |                                                                                                                                                                                                                                                                                                                                                                               |                    241 | 0..1          |
Query Processing Conditions ( QueryProcessingConditions )
The service nodes contain the service's business data.
Fields for the QueryProcessingConditions Node
| Field                          | Description                                                                                                                                              | Maximum Field Length   | Cardinality   |
|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| QueryHitsTotalNumberIn dicator | The following values exist: • True • False (default)                                                                                                     |                        | 1             |
| QueryHitsMaximumNumber Value   | Enter the maximum number of hits. If no value is entered, the default is automatically set to 1000.                                                      | 999999999              | 0..1          |
| QueryHitsUnlimitedIndi cator   | The following values exist: • True • False (default) Set True to get all data based                                                                      |                        | 1             |
| QueryLastReturnedObjec tID     | The following values exist: • True • False (default) If QueryHitsMaximumNumber Value is set and more data is available, you can set this value to True . |                        | 0..1          |
## Sample Payload
<!-- image -->
## Service Response
Business User ( BusinessUser )
##  Note
The fields below the node User will be filled.
| Node or Field                          | Node or Field               | Description                | Maximum Field Length   | Cardinality   |
|----------------------------------------|-----------------------------|----------------------------|------------------------|---------------|
| PersonExternalID                       | PersonExternalID            | Person External ID         | 60                     | 0..1          |
| PersonID                               | PersonID                    | Person ID                  | 10                     | 1             |
| PersonUUID                             | PersonUUID                  | Person UUID                | 36                     | 1             |
| BusinessPartnerRoleCode                | BusinessPartnerRoleCode     | Business Partner Role Code | 6                      | 1             |
| MarkedForArchivingIndicator            | MarkedForArchivingIndicator | • True • False             |                        | 1             |
| ValidityPeriod Cardinality: 0..1       | StartDate                   | Format: YYYY-MM-DD         |                        | 1             |
|                                        | EndDate                     | Format: YYYY-MM-DD         |                        | 1             |
| PersonalInform ation Cardinality: 0..1 | FormOfAddress               | Form of address            | 4                      | 0..1          |
| PersonalInform ation Cardinality: 0..1 | FirstName                   | First name                 | 40                     | 0..1          |
| PersonalInform ation Cardinality: 0..1 | LastName                    | Last name                  | 40                     | 0..1          |
| PersonalInform ation Cardinality: 0..1 | PersonFullName              | Person full name           | 80                     | 0..1          |
| PersonalInform ation Cardinality: 0..1 | AcademicTitle               | Academic title             | 4                      | 0..1          |
| PersonalInform ation Cardinality: 0..1 | CorrespondenceLanguage      | Correspondence language    | 9                      | 0..1          |
| PersonalInform ation Cardinality: 0..1 | MiddleName                  | Middle name                | 40                     | 0..1          |
| Node or Field         |                      | Description             |   Maximum Field Length | Cardinality   |
|-----------------------|----------------------|-------------------------|------------------------|---------------|
|                       | AdditionalLastName   | Additional last name    |                     40 | 0..1          |
|                       | BirthName            | Birth name              |                     40 | 0..1          |
|                       | NickName             | Nick name               |                     40 | 0..1          |
|                       | Initials             | Initials                |                     10 | 0..1          |
|                       | AcademicSecondTitle  | Academic second title   |                      4 | 0..1          |
|                       | LastNamePrefix       | Last name prefix        |                      4 | 0..1          |
|                       | LastNameSecondPrefix | Last name second prefix |                      4 | 0..1          |
|                       | NameSupplement       | Namesupplement          |                      4 | 0..1          |
| User (only for Cloud) | UserID               | User ID                 |                     12 | 1             |
| Cardinality: 0..1     | UserName             | User name/Alias         |                     40 | 1             |
|                       | LogonLanguageCode    | Logon language          |                      9 | 0..1          |
Maximum Field
| Node or Field   | Description Length                                                                                                                                                                                                                                                                                                                                                                                                          |    | Cardinality   |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|---------------|
| DateFormatCode  | The following val- ues exist: • 1 - DD.MM.YYYY (Gregorian Date) • 2 -MM/DD/ YYYY (Gre- gorian Date) • 3 - MM-DD- YYYY (Gre- gorian Date) • 4 - YYYY.MM.DD (Gregorian Date) • 5 - YYYY/MM/D D(Gregorian Date) • 6 - YYYY-MM- DD(Gregorian Date, ISO 8601) • 7 - GYY.MM.DD (Japanese Date) • 8 - GYY/MM/DD (Japanese Date) • 9 - GYY-MM- DD(Japanese Date) • A - YYYY/MM/D D(Islamic Date 1) • B- YYYY/MM/D D(Islamic Date 2) |  2 | 0..1          |
| Node or Field   |                   | Maximum Field Length                                                                                                                                                                                         |   Description | Cardinality   |
|-----------------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------------|
|                 | DecimalFormatCode | • C- YYYY/MM/D D(Iranian Date) The following val-                                                                                                                                                            |             2 | 0..1          |
|                 | TimeZoneCode      | Time zone                                                                                                                                                                                                    |            10 | 0..1          |
|                 | TimeFormatCode    | The following val- ues exist:                                                                                                                                                                                |             2 | 0..1          |
|                 | LockedIndicator   | • 1 - 12 Hour Format (Ex- ample: 12:05:10 PM) • 2 - 12 Hour Format (Ex- ample: 12:05:10 pm) • 3 - Hours from 0 to 11 (Example: 00:05:10 PM) • 4 - Hours from 0 to 11 (Example: 00:05:10 pm) Locked indicator |             5 | 0..1          |
| Node or Field                     |                                                          |                          | Description                                                                             | Maximum Field Length   | Cardinality   |
|-----------------------------------|----------------------------------------------------------|--------------------------|-----------------------------------------------------------------------------------------|------------------------|---------------|
|                                   | ValidityPeriod Cardinality: 1                            | StartDate                | Format: YYYY-MM-DD If no start date is maintained the User , the StartDate for entered. |                        | 1             |
|                                   |                                                          | EndDate                  | for the BusinessUser is Format:                                                         |                        | 1             |
|                                   | Role Cardinality: 0..un- bounded                         | RoleName                 | Role name                                                                               | 40                     | 1             |
| UserAssignment (only for on-prem- | UserID                                                   |                          | User ID                                                                                 | 12                     | 1             |
| ise)                              | UserName                                                 |                          |                                                                                         | 40                     | 0..1          |
| Cardinality: 0..1                 | UserAssignmentStatusCode                                 |                          | The following val- ues exist: • 1 - is reserved • 2 - is assigned                       | 1                      | 1             |
| WorkplaceInfor mation             | EmailAddress                                             |                          | Email address                                                                           | 241                    | 0..1          |
| Cardinality: 0..1                 | PhoneInformati on                                        | PhoneType                | Phone type                                                                              | 1                      | 1             |
| Cardinality: 0..1                 | Cardinality: 0..2                                        | CountryDialing Code      | Country dialing code                                                                    | 10                     | 0..1          |
| Cardinality: 0..1                 | One set of phone information per phone type sup- ported. | PhoneNumberAre aID       | Phone number area code                                                                  | 10                     | 0..1          |
| Cardinality: 0..1                 |                                                          | PhoneNumberSub scriberID | Phone number subscriber ID                                                              | 30                     | 0..1          |
| Cardinality: 0..1                 |                                                          | PhoneNumberExt ension    | Phone number ex- tension                                                                | 10                     | 0..1          |
| Node or Field       | Description           |   Maximum Field Length | Cardinality   |
|---------------------|-----------------------|------------------------|---------------|
| FunctionalTitleName | Functional title name |                     40 | 0..1          |
| Department          | Department name       |                     40 | 0..1          |
| RoomNumber          | Room number           |                     10 | 0..1          |
| Building            | Building name         |                     10 | 0..1          |
## Response Processing Conditions ( ResponseProcessingConditions )
| Field                         | Description                                                                                                                                 | Maximum Field Length   | Cardinality   |
|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| HitsTotalNumberValue          | Contains the number of users based on given criteria.                                                                                       | 999999999              | 1             |
| ReturnedQueryHitsNumbe rValue | Contains the number of found data sets for business users.                                                                                  | 999999999              | 1             |
| MoreHitsAvailableIndia ctor   | The indicator is set if the query was limited to a num- ber of hits, but more busi- ness user data sets are avail- able based on the query. |                        | 1             |
| LastReturnedObjectID          | Displays the last row of the results list limited by the found hits or by the value given for QueryHitsMaximumNumber Value .                | 999999999              | 0..1          |
## Log ( Log )
If errors occur, the log contains the information shown in the table below:
| Field or Node                        | Description                                                                                                                           |   Maximum Field Length | Cardinality   |
|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|
| BusinessDocumentProcessingResultCode |                                                                                                                                       |                      2 | 0..1          |
| MaximumLogItemSeverityCode           | If several messages are stored for a business user, the most severe level is shown from the maximum of all re- ceived severity codes. |                      1 | 0..1          |
| Field or Node               |              | Description                                                             | Maximum Field Length   | Cardinality   |
|-----------------------------|--------------|-------------------------------------------------------------------------|------------------------|---------------|
| Item                        | TypeID       | Message number                                                          | 40                     | 0..1          |
| Cardinality: 0..un- bounded | CateoryCode  | Not in use                                                              | 15                     | 0..1          |
|                             | SeverityCode | Severity code defini- tion: • 1 - Information • 2 - Warning • 3 - Error | 1                      | 0..1          |
|                             | Note         | Contains the message texts.                                             | 200                    | 1             |
|                             | WebURI       | Not in use                                                              |                        | 0..1          |
## Constraints
This service does not support:
- Freelancer (BBP010) business users
## Additional Information
##  Note
For more details about Communication Management, see Communication Management [page 2707].