| Description | Manage Leads |
| Name | ManageMarketingLeadIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Lead Processing |
| Process Component Name | LeadProcessing |
| Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
| Deploymnent Unit Description | Customer Relationship Management |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Deprecated |
An interface to replicate leads from a source system or file to a target system.
This web service is used to create new leads and modify existing leads.
It has the MaintainBundle and CheckMaintainBundle operations. The MaintainBundle is used to update one or more instances of the lead. The CheckMaintainBundle is used to check if one or more instances of the lead can be maintained.
This example structure shows the possible elements and attributes:
<n0:MarketingLeadBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID></ID> <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID> <ReferenceID></ReferenceID> <ReferenceUUID></ReferenceUUID> </BasicMessageHeader> <MarketingLead actionCode="01" itemListCompleteTransmissionIndicator="true"> <ObjectNodeSenderTechnicalID>Marketing_Lead_1</ObjectNodeSenderTechnicalID> <ChangeStateID></ChangeStateID> <UUID></UUID> <ID></ID> <Name>Lead 1</Name> <QualificationLevelCode>01</QualificationLevelCode> <OriginTypeCode>001</OriginTypeCode> <GroupCode>0023</GroupCode> <StatusCode>01</StatusCode> <CampaignPredecessorReferenceID>1</CampaignPredecessorReferenceID> <EmployeeInternalID>MC2471</EmployeeInternalID> <Note>This is a new Lead, created with WebService</Note> <PersonFirstName>Lead Person First Name</PersonFirstName> <PersonLastName>MLead Person Last Name</PersonLastName> <CompanyName>Lead Organisation First Name</CompanyName> <Address> <CountryCode>DE</CountryCode> <RegionCode>10</RegionCode> <StreetPostalCode>66386</StreetPostalCode> <CityName>St. Ingbert</CityName> <StreetName>Neue Bahnhofstr.</StreetName> <HouseID>21</HouseID> <TelephoneFormattedNumberDescription>111111</TelephoneFormattedNumberDescription> <MobileFormattedNumberDescription>222222</MobileFormattedNumberDescription> <EmailURI>person.test@x.y</EmailURI> </Address> + <Item> + <AttachmentFolder> </MarketingLead> </n0:MarketingLeadBundleMaintainRequest_sync>
The following business data are only referenced and will not be created by the service operations. They must exist in the system already at the time the web service is called:
Employee
Products, Materials, Services
Campaigns
The following elements are mandatory and need to be filled in the request message. Otherwise saving of the lead will be rejected:
PersonLastName ( Depends on scoping question of lead )
CompanyName
Action codes represent an instruction to the recipient of the web service request how to process transmitted message node elements. It is modeled as an attribute (Attribute name: actionCode) in every structure element of the message payload.
| Action Code | Description |
|---|---|
| 01 | Create; the system returns an error message if the node element already exists. |
| 02 | Update; the system returns an error message if the node element does not exist. |
| 03 | Delete; the system returns an error message if the node element does not exist. |
| 04 | Save; the system creates or changes the node element data. |
| 05 | Remove; the system deletes the node element. If the node element does not exist, the system does not send an error message. |
| 06 | No Action; the system does not change the node element. |
The ActionCodes "01" (Create), "02" (Change), "03" (Delete), and "06" (No Action) model strict semantics that lead to errors at the recipient if the elements corresponding to the actions requested by the sender exist ("01") or do not exist ("02", "03", "06") at the recipient. Using strict semantics, therefore, requires that the sender has and uses information about the messages it has already sent.
The ActionCodes "04" (Save) and "05" (Remove) model soft semantics that do not lead to errors if the respective elements do not exist at the recipient. These soft semantics, therefore, do not require that the sender has and uses information about the messages it has already sent.
Note: If no ActionCode is provided for a respective node, the system defaults it with value ‘04’.
Using change state identifier (element name "ChangeStateID"), external applications can enforce that a modifying operation is not executed because the state of the business document has changed since the external application read its data.
The change state ID is a not interpretable string that is provided by query and read operations and can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the service consumer, the system performs the service operation without checking the state of the business document.
The service consumer (external application) is responsible for preventing accidental changes to business documents.
The processing of node elements with cardinality > 1 can be controlled using List Complete Transmission Indicators (LCTI). The LCTI indicates whether a list of node elements is transmitted completely. The LCTI of a node element with cardinality > 1 is modeled as an attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).
| LCTI | Description |
|---|---|
| false | The list of node elements is not transmitted completely and hence all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be identified uniquely, the system processes the node elements according the action code. If transmitted node elements in the list cannot be identified uniquely, the system appends the node element to the corresponding list of node elements in the target business document. |
| true | The list of elements is transmitted completely and hence all node elements that are not transmitted are removed. If no node element is transmitted, the complete list is removed. |
Example: The lead node has an itemListCompleteTransmissionIndicator. If a lead has already 23 items in the system and the consumer wants to add two additional ones s/he should pass these two new items with ActionCode 01 in the message payload and should set the itemLCTI to false. Then the two items are added and the already existing 3 items are kept. If the consumer wants to remove all items except those two just added s/he should again pass these two items but should set the itemLCTI to True. Then all items are removed which are not contained in the message payload.
Optional elements in request messages that are not transmitted within a service request are not changed in corresponding business objects.
Example(1): Name is set to initial and QualificationLevelCode is changed to 03:
<MarketingLead actionCode="02" itemListCompleteTransmissionIndicator="false"> <ID>16407</ID> <Name></Name> <QualificationLevelCode>03</QualificationLevelCode> </MarketingLead>
Example(2): Name is not changed and QualificationLevelCode is changed to 03:
<MarketingLead actionCode="02 "itemListCompleteTransmissionIndicator="false"> <ID>16407</ID> <QualificationLevelCode>03</QualificationLevelCode> </MarketingLead>
Maintain bundle and check maintain bundle operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer is responsible for ensuring reasonable sizes of data for mass operations.
Maintain bundle and check maintain bundle operations support exactly one execution (idem potency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements ID or UUID of the BasicMessageHeader node element.
Using change state identifier (element name ChangeStateID), external applications can enforce that a modifying operation is not executed because the state of the business document has changed since the external application last read its data.
The change state ID is an uninterpretable string that is provided by query and read operations and can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document.
The web service consumer (external application) is responsible for preventing accidental changes to business documents.
Request node elements with cardinality > 1 contain an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message.
The object node sender technical identifiers are provided as ObjectNodeSenderTechnicalID in request message types and referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types.
If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request is returned as the reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID is returned as initial as well.
Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements for only a single call. The web service consumer is not required to specify them or to use the same values for different calls. Also, the service provider does not interpret these values at all, but returns them to the web service consumer instead in the ReferenceObjectNodeSenderTechnicalID elements.
Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.
Example
Request:
Show full documentation
Show full documentation
<Child>
<ObjectNodeSenderTechnicalID>999_A<ObjectNodeSenderTechnicalID>
<Content>Child A: Some correct content</Content>
</Child>
<Child>
<ObjectNodeSenderTechnicalID>999_B<ObjectNodeSenderTechnicalID>
<Content>Child B: Some erroneous content</Content>
</Child>
Response:
<Log>
<Item>
<ReferenceObjectNodeSenderTechnicalID>999_B </ReferenceObjectNodeSenderTechnicalID>
<Note>Error message for Child B</Note>
</Item>
</Log>
The structure of the response message consists of two parts:
A business document-specific part containing information about IDs and UUIDs of the created and changed business documents
Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request
Leads with status "Converted" cannot be changed anymore. Once this status is set it cannot be removed.
Leads cannot be converted by usage of this web service.
(e.g. the conversion of lead to account/contact or convert to opportunity is not supported via this web service)
Leads cannot be deleted by usage of this web service.
A request message like
<MarketingLead actionCode="03 "itemListCompleteTransmissionIndicator="false"> <ID>16407</ID> <QualificationLevelCode>03</QualificationLevelCode> </MarketingLead>
will result in an error in the log of the response message.
This means you cannot use the actionCode 03 and 05 for the node MarketingLead in the message.
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Possible scenarios include the following:
Create a lead
Update a lead
Example web service request to create a lead:
create a lead with inactive account/contact,two items and a relation to a campaign
Request:
<n0:MarketingLeadBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID></ID> <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID> <ReferenceID></ReferenceID> <ReferenceUUID></ReferenceUUID> </BasicMessageHeader> <MarketingLead actionCode="01" itemListCompleteTransmissionIndicator="true"> <ObjectNodeSenderTechnicalID>Marketing_Lead_1</ObjectNodeSenderTechnicalID> <ChangeStateID></ChangeStateID> <UUID></UUID> <ID></ID> <Name>Lead 1</Name> <QualificationLevelCode>01</QualificationLevelCode> <OriginTypeCode>001</OriginTypeCode> <GroupCode>0023</GroupCode> <StatusCode>01</StatusCode> <CampaignPredecessorReferenceID>1</CampaignPredecessorReferenceID> <EmployeeInternalID>MC2471</EmployeeInternalID> <Note>This is a new Lead with inactive account and contact, created with WebService</Note> <PersonFirstName>Lead Person First Name</PersonFirstName> <PersonLastName>Lead Person Last Name</PersonLastName> <CompanyName>Lead Organisation First Name</CompanyName> <Address> <CountryCode>DE</CountryCode> <RegionCode>10</RegionCode> <StreetPostalCode>66386</StreetPostalCode> <CityName>St. Ingbert</CityName> <StreetName>Neue Bahnhofstr.</StreetName> <HouseID>21</HouseID> <TelephoneFormattedNumberDescription>111111</TelephoneFormattedNumberDescription> <MobileFormattedNumberDescription>222222</MobileFormattedNumberDescription> <EmailURI>person.test@x.y</EmailURI> </Address> <Item actionCode="01"> <ObjectNodeSenderTechnicalID>Marketing_Lead_1_Item_1</ObjectNodeSenderTechnicalID> <UUID></UUID> <ID></ID> <Description languageCode="EN">Description Product 1</Description> <QuantityValue unitCode="EA">11</QuantityValue> <ProductUUID></ProductUUID> <MaterialInternalID>MCF-0001</MaterialInternalID> <ServiceProductInternalID></ServiceProductInternalID> <ProductCategoryInternalID></ProductCategoryInternalID> </Item> <Item actionCode="01"> <ObjectNodeSenderTechnicalID>Marketing_Lead_1_Item_2</ObjectNodeSenderTechnicalID> <UUID></UUID> <ID></ID> <Description languageCode="EN">Product 2: only category</Description> <QuantityValue unitCode="EA">200</QuantityValue> <ProductUUID></ProductUUID> <MaterialInternalID></MaterialInternalID> <ServiceProductInternalID></ServiceProductInternalID> <ProductCategoryInternalID>50-10</ProductCategoryInternalID> </Item> </MarketingLead> </n0:MarketingLeadBundleMaintainRequest_sync>
Response:
<nm:MarketingLeadBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ALP:/1SAI/TAEC08D44E1498DB2599D27:804"> <MarketingLead> <ReferenceObjectNodeSenderTechnicalID>Marketing_Lead_1</ReferenceObjectNodeSenderTechnicalID> <ChangeStateID>20120907081639.5075570</ChangeStateID> <UUID>00163e02-8b12-1ee1-be98-8b0ff8ea5a7e</UUID> <ID>16688</ID> </MarketingLead> <Log> <MaximumLogItemSeverityCode>2</MaximumLogItemSeverityCode> <Item> <TypeID>017(/CL_CDA_ORGPT/)</TypeID> <CategoryCode>INC.BOI</CategoryCode> <SeverityCode>2</SeverityCode> <ReferenceObjectNodeSenderTechnicalID>Marketing_Lead_1</ReferenceObjectNodeSenderTechnicalID> <Note>1 additional sales areas exist for organizational unit GCAT-4200 (Dept-Sales)</Note> </Item> </Log> </nm:MarketingLeadBundleMaintainConfirmation_sync>
create a lead with inactive individual customer
Request:
<n0:MarketingLeadBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID></ID> <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID> <ReferenceID></ReferenceID> <ReferenceUUID></ReferenceUUID> </BasicMessageHeader> <MarketingLead actionCode="01" itemListCompleteTransmissionIndicator="true"> <ObjectNodeSenderTechnicalID>Marketing_Lead_1</ObjectNodeSenderTechnicalID> <ChangeStateID></ChangeStateID> <UUID></UUID> <ID></ID> <Name>Lead 1</Name> <IndividualCustomerGivenName>Tester</IndividualCustomerGivenName> <IndividualCustomerFamilyName>SAP</IndividualCustomerFamilyName> <QualificationLevelCode>01</QualificationLevelCode> <OriginTypeCode>001</OriginTypeCode> <GroupCode>0023</GroupCode> <StatusCode>01</StatusCode> <EmployeeInternalID>MC2471</EmployeeInternalID> <Note>This is a new Lead with active account contact, created with WebService</Note> </MarketingLead> </n0:MarketingLeadBundleMaintainRequest_sync>
Response:
<nm:MarketingLeadBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ALP:/1SAI/TAEC08D44E1498DB2599D27:804"> <MarketingLead> <ReferenceObjectNodeSenderTechnicalID>Marketing_Lead_1</ReferenceObjectNodeSenderTechnicalID> <ChangeStateID>20120907081639.5075570</ChangeStateID> <UUID>00163e02-8b12-1ee1-be98-8b0ff8ea5a7e</UUID> <ID>16688</ID> </MarketingLead> <Log> <MaximumLogItemSeverityCode>2</MaximumLogItemSeverityCode> <Item> <TypeID>017(/CL_CDA_ORGPT/)</TypeID> <CategoryCode>INC.BOI</CategoryCode> <SeverityCode>2</SeverityCode> <ReferenceObjectNodeSenderTechnicalID>Marketing_Lead_1</ReferenceObjectNodeSenderTechnicalID> <Note>1 additional sales areas exist for organizational unit GCAT-4200 (Dept-Sales)</Note> </Item> </Log> </nm:MarketingLeadBundleMaintainConfirmation_sync>
create a lead with active account and contact or with active individual customer
(if create a lead with active individual customer, then in the <AccountInternalID>IND1000</AccountInternalID>, "IND1000" is the internal ID of individual customer and <MainContactPersonInternalID> should be empty)
Request:
<n0:MarketingLeadBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID></ID> <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID> <ReferenceID></ReferenceID> <ReferenceUUID></ReferenceUUID> </BasicMessageHeader> <MarketingLead actionCode="01" itemListCompleteTransmissionIndicator="true"> <ObjectNodeSenderTechnicalID>Marketing_Lead_1</ObjectNodeSenderTechnicalID> <ChangeStateID></ChangeStateID> <UUID></UUID> <ID></ID> <Name>Lead 1</Name> <UseExistingAccountContactIndicator>true</UseExistingAccountContactIndicator> <ProspectParty> <AccountInternalID>C1000</AccountInternalID> <MainContactPersonInternalID>CP1000_1</MainContactPersonInternalID> </ProspectParty> <QualificationLevelCode>01</QualificationLevelCode> <OriginTypeCode>001</OriginTypeCode> <GroupCode>0023</GroupCode> <StatusCode>01</StatusCode> <EmployeeInternalID>MC2471</EmployeeInternalID> <Note>This is a new Lead with active account contact, created with WebService</Note> </MarketingLead> </n0:MarketingLeadBundleMaintainRequest_sync>
Response:
<nm:MarketingLeadBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ALP:/1SAI/TAEC08D44E1498DB2599D27:804"> <MarketingLead> <ReferenceObjectNodeSenderTechnicalID>Marketing_Lead_1</ReferenceObjectNodeSenderTechnicalID> <ChangeStateID>20120907081639.5075570</ChangeStateID> <UUID>00163e02-8b12-1ee1-be98-8b0ff8ea5a7e</UUID> <ID>16688</ID> </MarketingLead> <Log> <MaximumLogItemSeverityCode>2</MaximumLogItemSeverityCode> <Item> <TypeID>017(/CL_CDA_ORGPT/)</TypeID> <CategoryCode>INC.BOI</CategoryCode> <SeverityCode>2</SeverityCode> <ReferenceObjectNodeSenderTechnicalID>Marketing_Lead_1</ReferenceObjectNodeSenderTechnicalID> <Note>1 additional sales areas exist for organizational unit GCAT-4200 (Dept-Sales)</Note> </Item> </Log> </nm:MarketingLeadBundleMaintainConfirmation_sync>
Example web service request to update a lead:
Change the note of the lead, change the status, change the email address and add a second item and two new attachments (one of type link, the other one of type file)
Request:
<n0:MarketingLeadBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID></ID>
<UUID>87654321-90AB-CDEF-0123-456789ABCDEF</UUID>
<ReferenceID></ReferenceID>
<ReferenceUUID></ReferenceUUID>
</BasicMessageHeader>
<MarketingLead actionCode="02" itemListCompleteTransmissionIndicator="false">
<ObjectNodeSenderTechnicalID>Marketing_Lead_1</ObjectNodeSenderTechnicalID>
<ChangeStateID></ChangeStateID>
<UUID></UUID>
<ID>16688</ID>
<Name>Lead 1</Name>
<StatusCode>02</StatusCode>
<Note>CHANGED CHANGED: This is a new Lead, created with WebService</Note>
<PersonLastName>Lead Person Last Name</PersonLastName>
<CompanyName>Lead Organisation First Name</CompanyName>
<Address>
<EmailURI>this.is.a.new.email.address@x.y</EmailURI>
</Address>
<Item actionCode="01">
<ObjectNodeSenderTechnicalID>Marketing_Lead_1_Item_3</ObjectNodeSenderTechnicalID>
<UUID></UUID>
<ID></ID>
<Description languageCode="EN">a third product</Description>
<QuantityValue unitCode="EA">333</QuantityValue>
<ProductUUID></ProductUUID>
<MaterialInternalID>MCF-0003</MaterialInternalID>
<ServiceProductInternalID></ServiceProductInternalID>
<ProductCategoryInternalID></ProductCategoryInternalID>
</Item>
<AttachmentFolder DocumentListCompleteTransmissionIndicator="true" ActionCode="01">
<UUID schemeID="" schemeAgencyID=""></UUID>
<Document PropertyListCompleteTransmissionIndicator="true" ActionCode="01">
<UUID schemeID="" schemeAgencyID=""></UUID>
<LinkInternalIndicator>false</LinkInternalIndicator>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>2</CategoryCode>
<TypeCode listID="" listVersionID="" listAgencyID="" listAgencySchemeID="" listAgencySchemeAgencyID="">10001</TypeCode>
<MIMECode>text/plain</MIMECode>
<Name>for upload.txt</Name>
<AlternativeName>for upload.txt</AlternativeName>
<InternalLinkUUID schemeID="" schemeAgencyID=""></InternalLinkUUID>
<Description languageCode="EN">uploaded file</Description>
<ExternalLinkWebURI>http://xxx.yyy.zzz</ExternalLinkWebURI>
<Property PropertyValueListCompleteTransmissionIndicator="true" ActionCode="01">
<TechnicalID></TechnicalID>
<Name>This is a property of uploaded file</Name>
<DataTypeFormatCode>string</DataTypeFormatCode>
<VisibleIndicator>true</VisibleIndicator>
<ChangeAllowedIndicator>true</ChangeAllowedIndicator>
<MultipleValueIndicator>false</MultipleValueIndicator>
<NamespaceURI schemeID=""></NamespaceURI>
<Description languageCode="EN">a description of the attachment property</Description>
<PropertyValue ActionCode="01">
<TechnicalID></TechnicalID>
<Text>text of property value 1</Text>
<Indicator>true</Indicator>
<DateTime></DateTime>
<IntegerValue>1</IntegerValue>
</PropertyValue>
</Property>
<FileContent ActionCode="01">
<TechnicalID></TechnicalID>
<BinaryObject mimeCode="text/plain" characterSetCode="" format="" fileName="" uri="">7465737420746573742074657374</BinaryObject>
</FileContent>
</Document>
<Document PropertyListCompleteTransmissionIndicator="true" ActionCode="01">
<UUID schemeID="" schemeAgencyID=""></UUID>
<LinkInternalIndicator>false</LinkInternalIndicator>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>3</CategoryCode>
<TypeCode listID="" listVersionID="" listAgencyID="" listAgencySchemeID="" listAgencySchemeAgencyID="">10001</TypeCode>
<MIMECode></MIMECode>
<Name>xxx.yyy.zzz</Name>
<AlternativeName>an URL</AlternativeName>
<InternalLinkUUID schemeID="" schemeAgencyID=""></InternalLinkUUID>
<Description languageCode="EN">a link</Description>
<ExternalLinkWebURI>http://xxx.yyy.zzz</ExternalLinkWebURI>
<Property PropertyValueListCompleteTransmissionIndicator="true" ActionCode="01">
<TechnicalID></TechnicalID>
<Name>This is a NAME</Name>
<DataTypeFormatCode>string</DataTypeFormatCode>
<VisibleIndicator>true</VisibleIndicator>
<ChangeAllowedIndicator>true</ChangeAllowedIndicator>
<MultipleValueIndicator>false</MultipleValueIndicator>
<NamespaceURI schemeID="">http://sap.com</NamespaceURI>
<Description languageCode="EN">a description of the attachment property</Description>
<PropertyValue ActionCode="01">
<TechnicalID></TechnicalID>
<Text>text of property value 1</Text>
<Indicator>true</Indicator>
<DateTime></DateTime>
<IntegerValue>1</IntegerValue>
</PropertyValue>
<PropertyValue ActionCode="01">
<TechnicalID></TechnicalID>
<Text>property value 2</Text>
<Indicator>false</Indicator>
<DateTime></DateTime>
<IntegerValue>2</IntegerValue>
</PropertyValue>
</Property>
</Document>
</AttachmentFolder>
</MarketingLead>
</n0:MarketingLeadBundleMaintainRequest_sync>
Response:
<nm:MarketingLeadBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QKA:/1SAI/TAEC08D44E1498DB2599D27:804"> <MarketingLead> <ReferenceObjectNodeSenderTechnicalID>Marketing_Lead_1</ReferenceObjectNodeSenderTechnicalID> <ChangeStateID>20120907085154.5454340</ChangeStateID> <UUID>00163e02-9048-1ee1-be99-2007754867fe</UUID> <ID>16688</ID> </MarketingLead> <Log /> </nm:MarketingLeadBundleMaintainConfirmation_sync>
| Description | Maintain marketing leads |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To create or update leads.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element, as well as a MarketingLead node element containing the data to be created or updated. The detailed structure of the node is explained below. The node can occur multiple times in the request message, meaning that multiple leads can be created and updated through a single Web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a MarketingLead-specific node with ReferenceObjectNodeSenderTechnicalID and ChangeStateID, as well as ID and UUID.
The lead node element contains all elements of a lead such as ID, UUID, name, qualification level code and other data.
The UUID is a unique identifier of the lead. It is generated by the Web service.
The ID is a unique identifier of the lead. It is automatically generated by the solution.
The Name describes the lead as it will be displayed on the user interface. Although this element is not mandatory, we recommend that you specify a name for better readability on the user interface.
The QualificationLevelCode specifies a classification of the potential interest of a lead.
The values of the QualificationLevelCode depend on your business configuration settings. The following values are pre-delivered by SAP, but you can define additional values in your business configuration:
| QualificationLevelCode | Description |
|---|---|
| 01 | Cold |
| 02 | Warm |
| 03 | Hot |
If a QualificationLevelCode is defined, then the StatusCode is automatically set to Qualified in the back end.
If a QualificationLevelCode is not specified by the consumer upon creation, or if it is removed by the consumer upon update, then the solution defines the StatusCode as Open, provided that the marketing lead does not possess the status Converted. Otherwise, removing the QualificationLevelCode leads to an error.
The OriginTypeCode indicates the origin of the lead.
The values of the OriginTypeCode depend on your business configuration settings. The following values are pre-delivered by SAP, but you can define additional values in your business configuration:
| OriginTypeCode | Description |
|---|---|
| 001 | Trade Fair |
| 002 | External Partner |
| 003 | Campaign |
| 004 | Telephone Inquiry |
| 005 | Roadshow |
| 006 | Avention |
If an OriginTypeCode is not specified by the consumer, then a default value is set by the Web service.
The GroupCode specifies the category to which the lead belongs.
Depending upon your business configuration settings, the GroupCode can contain the following values:
| GroupCode | Description |
|---|---|
| 0023 | Prospect for product sales |
| 0024 | Prospect for service |
| 0025 | Prospect for training |
| 0026 | Prospect for consulting |
The StatusCode indicates the current state of processing for the lead.
The values of the StatusCode depend on your business configuration settings. The following values are pre-delivered by SAP, but you can define additional values in your business configuration:
| StatusCode | Description |
|---|---|
| 01 | Open |
| 02 | Qualified |
If a StatusCode is not specified by the consumer, then a default value is set by the Web service, as follows:
If no QualificationLevelCode is specified, then the Web service sets the value of the marketing lead’s StatusCode as Open. If a QualificationLevelCode is specified, then the Web service sets the lead’s StatusCode as Qualified.
The Web service cannot set the StatusCode Converted for the lead. If the consumer attempts to set the value of StatusCode to Converted, then an error is issued.
The CampaignPredecessorReferenceID enables the lead to be referenced by a campaign that is its direct predecessor.
The EmployeeInternalID identifies the party who is responsible for the marketing side of the lead.
The MarketingUnitInternalID identifies the party that is a marketing unit of the lead.
The SalesUnitInternalID identifies the party that is a sales unit of the lead.
The Note enables text to be added to the lead.
The UseExistingAccountContactIndicator allows an existing account and contact to be added to the lead.
The PersonFirstName specifies the first name of the person associated with the lead.
The PersonMiddleName specifies the middle name of the person associated with the lead.
The PersonLastName specifies the last name of the person associated with the lead.
The PersonGenderCode specifies the gender of the person associated with the lead.
The following values are pre-delivered by SAP:
| PersonGenderCode | Description |
|---|---|
| 0 | Gender not known |
| 1 | Male |
| 2 | Female |
The PersonAcademicTitleCode specifies the academic title of the person associated with the lead.
The values of the PersonAcademicTitleCode depend on your business configuration settings. The following values are pre-delivered by SAP, but you can define additional values in your business configuration:
| PersonAcademicTitleCode | Description |
|---|---|
| 0001 | Dr. |
| 0002 | Prof. |
| 0003 | Prof. Dr. |
| 0004 | B.A. |
| 0005 | MBA |
| 0006 | Ph.D. |
The PersonAdditionalAcademicTitleCode specifies the additional academic title of the person associated with the lead.
The values of the PersonAdditionalAcademicTitleCode depend on your business configuration settings. The following values are pre-delivered by SAP, but you can define additional values in your business configuration:
| PersonAdditionalAcademicTitleCode | Description |
|---|---|
| 0001 | Dr. |
| 0002 | Prof. |
| 0003 | Prof. Dr. |
| 0004 | B.A. |
| 0005 | MBA |
| 0006 | Ph.D. |
The PersonContactAllowedCode describes whether it is permissible to contact the person associated with the lead.
The following values are pre-delivered by SAP:
| PersonContactAllowedCode | Description |
|---|---|
| 1 | Allowed |
| 2 | Disallowed |
| 3 | Check Permission |
The ContactCorrespondenceLanguageCode indicates the language that is used by the person associated with the lead.
The ContactNotes enables text to be added to the person associated with the lead.
The CompanyName specifies the name of the company associated with the lead.
The CompanySecondLineName specifies the second line of the name of the company associated with the lead.
The CompanyThirdLineName specifies the third line of the name of the company associated with the lead.
The CompanyFourthLineName specifies the fourth line of the name of the company associated with the lead.
The CompanyContactAllowedCode describes whether it is permissible to contact the company associated with the lead.
The following values are pre-delivered by SAP:
| PersonContactAllowedCode | Description |
|---|---|
| 1 | Allowed |
| 2 | Disallowed |
| 3 | Check Permission |
The AccountNotes enables text to be added to the company associated with the lead.
The Address specifies the postal address attributes of the company associated with the marketing lead, such as the country or city, and the communication attributes, such as the telephone number or e-mail address.
This node element contains the identification of the prospect party, the contacts of the prospect party and the main indicator flag.
Either the business partner internal ID or the business partner UUID can be provided. If both identifiers are provided, then the business partner UUID is used.
Example:
<ProspectParty partyContactPartyListCompleteTransmissionIndicator="true" actionCode="01">
<AccountInternalID>MC9785</AccountInternalID>
<ContactParty actionCode="01">
<ContactPersonInternalID>MCP9785</ContactPersonInternalID>
<MainIndicator>true</MainIndicator>
</ContactParty>
<ContactParty actionCode="01">
<ContactPersonInternalID>MCPC9785</ContactPersonInternalID>
</ContactParty>
The Item node contains all information regarding products, product categories or product descriptions of interest to the lead.
Each item is defined by a combination of ID, Description, QuantityValue, a MaterialID, a ServiceProductID, a ProductStandardID and a ProductCategoryInternalID.
Example for creating a new item:
<Item actionCode="01"> <ID>10</ID> <Description languageCode="EN">A2X Example for Lead item</Description> <QuantityValue unitCode="EA">2</QuantityValue> <MaterialInternalID>10000335</MaterialInternalID> </Item>
When you update an item that already contains a MaterialID, a ServiceProductID or a ProductStandardID, do not specify the ProductCategoryInternalID, because this can no longer be changed if the item already has a product ID.
If the ProductCategoryInternalID is provided upon update and if its value differs from the originally maintained ProductCategoryInternalID, then the solution issues an error message in the response, stating that because the field is read-only, the product category ID cannot be changed.
The Event node contains the information of the events that triggered the lead.
The AttachmentFolder node element can be used to add and remove marketing lead attachments.
Data for this node can be found as attachments on the marketing lead user interface, where files and links can be created. In the Web service request, links and files are differentiated by the CategoryCode, as follows:
| Category code | Description |
|---|---|
| 2 | Document |
| 3 | Link |
Attachment types are differentiated by the TypeCode:
| Type code | Description |
|---|---|
| 10001 | Standard Attachment |
In order to create link attachments, the document elements must appear as follows:
<AttachmentFolder ActionCode="04"> <Document ActionCode="04"> <VisibleIndicator>true</VisibleIndicator> <CategoryCode>3</CategoryCode> <TypeCode>10001</TypeCode> <Name>SAP AG Link</Name> <ExternalLinkWebURI>http://www.sap.com</ExternalLinkWebURI> <AlternativeName>SAP AG URL</AlternativeName> <Description languageCode="EN">A hyperlink to SAP AG</Description> </Document> </AttachmentFolder>
In order to create file attachments, the document elements must appear as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | <none> |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <Comment> |
| Description | Check marketing leads |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To check if marketing leads can be created or updated without errors.
The web service request and response message types for the CheckMaintainBundle operation are the same as those of the Maintain Bundle operation. The explanations given can therefore also be applied to the CheckMaintainBundle operation.