| Description | Manage Social Media User Profiles |
| Name | ManageSocialMediaUserProfileIn |
| 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 |
| Release Status | Deprecated |
An interface to create, change or delete social media user profiles from messages originating in an external social media provider.
The web service interface Manage Social Media User Profile In enables you to connect external applications to your SAP CRM OnDemand system and maintain social media user profiles.
This web service interface includes the following operations:
Check Maintain Bundle
Maintain Bundle
This web service is synchronous and mass enabled. Requesting large amounts of data can cause communication timeout. The web service consumer is responsible for ensuring requests are of a reasonable size for mass operations.
The structure of the request message consists of the following:
Message Header
Social Media Profile
Example of a Request Message
<n0:SocialMediaUserProfileBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID> </BasicMessageHeader> <SocialMediaUserProfile actionCode="01" userInformationListCompleteTransmissionIndicator="true"> <UUID></UUID> <ID></ID> <SocialMediaUserCategoryCode>01</SocialMediaUserCategoryCode> <InteractionContentParticipantSentimentTypeCode>01</InteractionContentParticipantSentimentTypeCode> <ExternalImportanceScoreNumberValue>21</ExternalImportanceScoreNumberValue> <AggregratedImportanceScoreNumberValue>22</AggregratedImportanceScoreNumberValue> <UserInformation actionCode="01"> <SocialMediaUserAccountID>35467</SocialMediaUserAccountID> <GenderCode>1</GenderCode> <SocialMediaChannelCode>001</SocialMediaChannelCode> <FamilyName>Miller</FamilyName> <GivenName>Jennifer</GivenName> <EmailURI></EmailURI> <SocialMediaUserName>JENNM</SocialMediaUserName> <objectNodeSenderTechnicalID>3456</objectNodeSenderTechnicalID> </UserInformation> <CustomerInternalID>1000570</CustomerInternalID> <ChangeStateID>23525</ChangeStateID> <ObjectNodeSenderTechnicalID>43653</ObjectNodeSenderTechnicalID> </SocialMediaUserProfile> </n0:SocialMediaUserProfileBundleMaintainRequest_sync>
The structure of the response message consists of three parts:
A business document-specific part containing the returned business documents
Processing conditions
Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request
You can find general information about Web services, their structure and consumption in the Web Services documentation.
| Description | Maintain social media user profiles |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To create, change or delete social media user profiles from messages sent by an external social media provider.
The operation Maintain Bundle processes the requests from external systems to to create, modify or delete a social media user profile.
It includes the following nodes:
The request message of the operation contains the following nodes:
Basic Message Header
This node contains the following elements:
| Element | Description |
|---|---|
| ID | Identifier of an instance of a business document message |
| UUID | Unique identifier of an instance of a business document message |
| ReferenceID | Identifier of a referenced instance of a business document message |
| ReferenceUUID | Reference unique identifier of a referenced instance of a business document message |
Social Media User Profile
This node contains the following elements and one child node, User Information (described below):
| Element | Description |
|---|---|
| actionCode | A coded representation of an instruction to the system receiving the message on how to process a transmitted element |
| Action Codes: 01= Create; 02 = Change; 03 = Delete; 04 = Save; 05 = Remove; 06 = No action (check) | |
| UUID | Universally unique identifier of the social media user profile |
| ID | Social media user profile ID |
| SocialMediaUserCategoryCode | A coded representation of the category of a social media user |
| Social Media User Category Codes: 01 = Standard User; 02 = Page | |
| InteractionContentParticipantSentimentTypeCode | A coded representation of the type of a sentiment expressed |
| Sentiment Type Codes: 01 = Strong Positive; 02 = Weak Positive; 03 = Neutral; 04 = Weak Negative; 05 = Strong Negative | |
| ExternalImportanceScoreNumberValue | A value that is the external number value assigned to a social media user based on the user's social influence, that is, the number of friends or followers the user has |
| AggregratedImportanceScoreNumberValue | A value that is the aggregated score of the external importance score of a social media user and the internal importance score of the customer related to that social media user |
| UserInformation | Social media user information derived from a specific social media channel (like Facebook or Twitter) |
| ContactPartyInternalID | Internal ID of the social media user contact party |
| CustomerInternalID | Internal ID of the social media user customer record |
| userInformationListCompleteTransmissionIndicator | Indicates that the user information node has been completely transmitted |
| If the value is set to true, any prior user information instance in the database for this social media user is replaced with the new instance. | |
| If the value is set to false, only elements in the new instance are copied leaving the other elements in the prior instance as-is. | |
| ChangeStateID | An identifier of a change state |
| The change state identifier is provided when calling a modifying operation. The system does not perform the operation if the state of the business object instance in the database has changed since the change state identifier was computed. By specifying the change state identifier, the client is enabled to implement optimisic locking. | |
| ObjectNodeSenderTechnicalID | A technical node identifier of an object or object node |
| These elements allow the service consumer to relate elements in the confirmation with the originating parts. In addition, they allow the service consumer to relate log messages with the originating parts in the client application. |
User Information
This node contains the following elements:
| Element Name | Description |
|---|---|
| actionCode | A coded representation of an instruction to the system receiving the message on how to process a transmitted element |
| SocialMediaUserAccountID | An identifier for a social media user's system account; typically a generated numeric value |
| GenderCode | A coded representation of the gender of a social media user |
| Gender Code List: 0 = Gender not known; 1 = Male; 2 = Female | |
| SocialMediaChannelCode | A coded representation of a social media channel |
| Channel Code List: 001 = Facebook; 002 = Twitter | |
| FamilyName | The last name (surname) of the social media user |
| GivenName | The first (given) name of a social media user |
| EmailURI | The uniform resource identifier for an account in an electronic mail system |
| SocialMediaUserName | The screen name of the social media user (a user's screen name may be different for each social media Web site they use) |
| SocialMediaUserImageURI | unique digital address, represented by the unified resource identifier, where a social media user's image can be accessed |
| objectNodeSenderTechnicalID | A technical node identifier of an object or object node |
The response message of the operation contains the following nodes:
Social Media User Profile
This node contains the following elements:
| Element | Description |
|---|---|
| ID | Social media user profile ID |
| UUID | Universally unique identifier of the social media user profile |
| objectNodeSenderTechnicalID | A technical node identifier of an object or object node |
| ChangeStateID | An identifier of a change state |
Log
This node contains the following elements:
| Element | Description |
|---|---|
| BusinessDocumentProcessingResultCode | Result of processing of a business document |
| MaximumLogItemSeverityCode | Coded representation of the maximum severity of a log message in a given log |
| Maximum Severity Codes: 1 = Information; 2 = Warning; 3 = Error; 4 = Abort | |
| objectNodeSenderTechnicalID | A technical node identifier of an object or object node |
| Description | Check social media user profiles |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To check if social media user profile master data can be created, updated or deleted without errors.
The operation Check Maintain Bundle processes the requests from external systems to check if a social medial user profile can be maintained.
This operation does not alter the data.
It includes the following nodes:
The request message of the operation contains the following nodes:
Basic Message Header
This node contains the following elements:
| Element | Description |
|---|---|
| ID | Identifier of an instance of a business document message |
| UUID | Unique identifier of an instance of a business document message |
| ReferenceID | Identifier of a referenced instance of a business document message |
| ReferenceUUID | Reference unique identifier of a referenced instance of a business document message |
Social Media User Profile
This node contains the following elements and one child node, User Information (described below):
| Element | Description |
|---|---|
| actionCode | A coded representation of an instruction to the system receiving the message on how to process a transmitted element |
| Action Codes: 01= Create; 02 = Change; 03 = Delete; 04 = Save; 05 = Remove; 06 = No action (check) | |
| UUID | Universally unique identifier of the social media user profile |
| ID | Social media user profile ID |
| SocialMediaUserCategoryCode | A coded representation of the category of a social media user |
| Social Media User Category Codes: 01 = Standard User; 02 = Page | |
| InteractionContentParticipantSentimentTypeCode | A coded representation of the type of a sentiment expressed |
| Sentiment Type Codes: 01 = Strong Positive; 02 = Weak Positive; 03 = Neutral; 04 = Weak Negative; 05 = Strong Negative | |
| ExternalImportanceScoreNumberValue | A value that is the external number value assigned to a social media user based on the user's social influence, that is, the number of friends or followers the user has |
| AggregratedImportanceScoreNumberValue | A value that is the aggregated score of the external importance score of a social media user and the internal importance score of the customer related to that social media user |
| UserInformation | Social media user information derived from a specific social media channel (like Facebook or Twitter) |
| ContactPartyInternalID | Internal ID of the social media user contact party |
| CustomerInternalID | Internal ID of the social media user customer record |
| userInformationListCompleteTransmissionIndicator | Indicates that the user information node has been completely transmitted |
| If the value is set to true, any prior user information instance in the database for this social media user is replaced with the new instance. | |
| If the value is set to false, only elements in the new instance are copied leaving the other elements in the prior instance as-is. | |
| ChangeStateID | An identifier of a change state |
| The change state identifier is provided when calling a modifying operation. The system does not perform the operation if the state of the business object instance in the database has changed since the change state identifier was computed. By specifying the change state identifier, the client is enabled to implement optimisic locking. | |
| ObjectNodeSenderTechnicalID | A technical node identifier of an object or object node |
| These elements allow the service consumer to relate elements in the confirmation with the originating parts. In addition, they allow the service consumer to relate log messages with the originating parts in the client application. |
User Information
This node contains the following elements:
| Element Name | Description |
|---|---|
| actionCode | A coded representation of an instruction to the system receiving the message on how to process a transmitted element |
| SocialMediaUserAccountID | An identifier for a social media user's system account; typically a generated numeric value |
| GenderCode | A coded representation of the gender of a social media user |
| Gender Code List: 0 = Gender not known; 1 = Male; 2 = Female | |
| SocialMediaChannelCode | A coded representation of a social media channel |
| Channel Code List: 001 = Facebook; 002 = Twitter | |
| FamilyName | The last name (surname) of the social media user |
| GivenName | The first (given) name of a social media user |
| EmailURI | The uniform resource identifier for an account in an electronic mail system |
| SocialMediaUserName | The screen name of the social media user (a user's screen name may be different for each social media Web site they use) |
| SocialMediaUserImageURI | unique digital address, represented by the unified resource identifier, where a social media user's image can be accessed |
| objectNodeSenderTechnicalID | A technical node identifier of an object or object node |
The response message of the operation contains the following nodes:
Social Media User Profile
This node contains the following elements:
| Element | Description |
|---|---|
| ID | Social media user profile ID |
| UUID | Universally unique identifier of the social media user profile |
| objectNodeSenderTechnicalID | A technical node identifier of an object or object node |
| ChangeStateID | An identifier of a change state |
Log
This node contains the following elements:
| Element | Description |
|---|---|
| BusinessDocumentProcessingResultCode | Result of processing of a business document |
| MaximumLogItemSeverityCode | Coded representation of the maximum severity of a log message in a given log |
| Maximum Severity Codes: 1 = Information; 2 = Warning; 3 = Error; 4 = Abort | |
| objectNodeSenderTechnicalID | A technical node identifier of an object or object node |
Show full documentation
Show full documentation