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	Maximum Field Length	Cardinality
`PersonExternalIDInterval` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`	The following values exist: 1- Equal No upper boundary value must be set. 3 - Between Upper boundary value is mandatory. 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 `LowerBoundaryPersonExtID` is set.	1	1
	`LowerBoundaryPersonExtID`	Employee name	60	0..1
	`UpperBoundaryPersonExtID`		60	0..1
`PersonIDInterval` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`	The following values exist: 1- Equal No upper boundary value must be set. 3 - Between Upper boundary value is mandatory. 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 `LowerBoundaryPersonID` is set.	1	1
	`LowerBoundaryPersonID`		10	0..1
	`UpperBoundaryPersonID`		10	0..1
`BusinessPartnerRoleCodeInterval` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`	The following values exist: 1- Equal No upper boundary value must be set. 3 - Between Upper boundary value is mandatory. 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 `LowerBoundaryBusinessPartnerRoleCode` is set.	1	1
	`LowerBoundaryBusinessPartnerRoleCode`	Only business partner role code BUP003 (Employee) is supported.	6	0..1
`MarkedForArchivingIndicator` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`	The following values exist: True False		1
`MarkedForArchivingIndicator` Cardinality: 0..unbounded	`LowerBoundaryMarkedForArchivingIndicator`		1	0..1
`UserIDInterval` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`	The following values exist: 1- Equal No upper boundary value must be set. 3 - Between Upper boundary value is mandatory. 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 `LowerBoundaryUserID` is set.	1	1
	`LowerBoundaryUserID`		12	0..1
	`UpperBoundaryUserID`		12	0..1
`UserNameInterval` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`	The following values exist: 1- Equal No upper boundary value must be set. 3 - Between Upper boundary value is mandatory. 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 `LowerBoundaryUserName` is set.	1	1
	`LowerBoundaryUserName`		40	0..1
	`UpperBoundaryUserName`		40	0..1
`FirstNameInterval` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`	The following values exist: 1- Equal No upper boundary value must be set. 3 - Between Upper boundary value is mandatory. 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 `LowerBoundaryFirstName` is set.	1	1
	`LowerBoundaryFirstName`		35	0..1
	`UpperBoundaryFirstName`		35	0..1
`LastNameInterval` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`	The following values exist: 1- Equal No upper boundary value must be set. 3 - Between Upper boundary value is mandatory. 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 `LowerBoundaryLastName` is set.	1	1
	`LowerBoundaryLastName`		40	0..1
	`UpperBoundaryLastName`		40	0..1
`EmailAddressInterval` Cardinality: 0..unbounded	`IntervalBoundaryTypeCode`		1	1
	`LowerBoundaryEmailAddress`		241	0..1
	`UpperBoundaryEmailAddress`		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
`QueryHitsTotalNumberIndicator`	The following values exist: True False (default)		1
`QueryHitsMaximumNumberValue`	Enter the maximum number of hits. If no value is entered, the default is automatically set to 1000.	999999999	0..1
`QueryHitsUnlimitedIndicator`	The following values exist: True False (default) Set True to get all data based on selection criteria.		1
`QueryLastReturnedObjectID`	The following values exist: True False (default) If `QueryHitsMaximumNumberValue` is set and more data is available, you can set this value to True.		0..1

Sample Payload

Sample Code:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aba="http://sap.com/xi/ABA">
   <soapenv:Header/>
   <soapenv:Body>
      <aba:BusinessUserSimpleByElementsQuery_sync>
         <BusinessUser>
            <PersonIDInterval>
               <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
               <!--Optional:-->
               <LowerBoundaryPersonID>9980035943</LowerBoundaryPersonID>
               <!--Optional:-->
            </PersonIDInterval>
            <BusinessPartnerRoleCodeInterval>
               <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
               <!--Optional:-->
               <LowerBoundaryBusinessPartnerRoleCode>bup003</LowerBoundaryBusinessPartnerRoleCode>
            </BusinessPartnerRoleCodeInterval>
         </BusinessUser>
         <QueryProcessingConditions>
            <!--Optional:-->
            <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue>
            <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
         </QueryProcessingConditions>
      </aba:BusinessUserSimpleByElementsQuery_sync>
   </soapenv:Body>
</soapenv:Envelope>

Service Response

Business User (BusinessUser)

Note:

The fields below the node User will be filled.

Node or Field			Description	Maximum Field Length	Cardinality
`PersonExternalID`			Person External ID	60	0..1
`PersonID`			Person ID	10	1
`PersonUUID`			Person UUID	36	1
`BusinessPartnerRoleCode`			Business Partner Role Code	6	1
`MarkedForArchivingIndicator`			True False		1
`ValidityPeriod` Cardinality: 0..1	`StartDate`		Format: YYYY-MM-DD		1
`ValidityPeriod` Cardinality: 0..1	`EndDate`		Format: YYYY-MM-DD		1
`PersonalInformation` Cardinality: 0..1	`FormOfAddress`		Form of address	4	0..1
	`FirstName`		First name	40	0..1
	`LastName`		Last name	40	0..1
	`PersonFullName`		Person full name	80	0..1
	`AcademicTitle`		Academic title	4	0..1
	`CorrespondenceLanguage`		Correspondence language	9	0..1
	`MiddleName`		Middle name	40	0..1
	`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`		Name supplement	4	0..1
`User` (only for Cloud) Cardinality: 0..1	`UserID`		User ID	12	1
	`UserName`		User name/Alias	40	1
	`LogonLanguageCode`		Logon language	9	0..1
	`DateFormatCode`		The following values exist: 1 - DD.MM.YYYY (Gregorian Date) 2 - MM/DD/YYYY (Gregorian Date) 3 - MM-DD-YYYY (Gregorian Date) 4 - YYYY.MM.DD (Gregorian Date) 5 - YYYY/MM/DD (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/DD (Islamic Date 1) B - YYYY/MM/DD (Islamic Date 2) C - YYYY/MM/DD (Iranian Date)	2	0..1
	`DecimalFormatCode`		The following values exist: 1.234.567,89 X - 1,234,567.89 Y - 1 234 567,89	2	0..1
	`TimeZoneCode`		Time zone	10	0..1
	`TimeFormatCode`		The following values exist: 0 - 24 Hour Format (Example: 12:05:10) 1 - 12 Hour Format (Example: 12:05:10 PM) 2 - 12 Hour Format (Example: 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)	2	0..1
	`LockedIndicator`		Locked indicator	5	0..1
	`ValidityPeriod` Cardinality: 1	`StartDate`	Format: YYYY-MM-DD If no start date is maintained for the `User`, the `StartDate` for the `BusinessUser` is entered.		1
	`ValidityPeriod` Cardinality: 1	`EndDate`	Format: YYYY-MM-DD If no `EndDate` is maintained, it is set to 9999-12-31.		1
	`Role` Cardinality: 0..unbounded	`RoleName`	Role name	40	1
`UserAssignment` (only for on-premise) Cardinality: 0..1	`UserID`		User ID	12	1
	`UserName`			40	0..1
	`UserAssignmentStatusCode`		The following values exist: 1 - is reserved 2 - is assigned	1	1
`WorkplaceInformation` Cardinality: 0..1	`EmailAddress`		Email address	241	0..1
	`PhoneInformation` Cardinality: 0..2 One set of phone information per phone type supported.	`PhoneType`	Phone type	1	1
		`CountryDialingCode`	Country dialing code	10	0..1
		`PhoneNumberAreaID`	Phone number area code	10	0..1
		`PhoneNumberSubscriberID`	Phone number subscriber ID	30	0..1
		`PhoneNumberExtension`	Phone number extension	10	0..1
	`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
`ReturnedQueryHitsNumberValue`	Contains the number of found data sets for business users.	999999999	1
`MoreHitsAvailableIndiactor`	The indicator is set if the query was limited to a number of hits, but more business user data sets are available 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 `QueryHitsMaximumNumberValue`.	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 received severity codes.	1	0..1
`Item` Cardinality: 0..unbounded	TypeID	Message number	40	0..1
	CateoryCode	Not in use	15	0..1
	SeverityCode	Severity code definition: 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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

inbound-service-business-user-read-535e7af.md

inbound-service-business-user-read-535e7af.md

Inbound Service: Business User - Read

Service Request

Sample Payload

Sample Code:

Service Response

Note:

Constraints

Additional Information

Note:

Files

inbound-service-business-user-read-535e7af.md

Latest commit

History

inbound-service-business-user-read-535e7af.md

File metadata and controls

Inbound Service: Business User - Read

Service Request

Sample Payload

Sample Code:

Service Response

Note:

Constraints

Additional Information

Note: