Bookshelf Home | Contents | Index | PDF     

Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

LeadService

Use this Web service to perform basic operations on the Lead entity, such create, update, convert, retire and reject leads.

LeadService Operations

For a list of operations associated with this Web service, see Table 230.

Table 230. LeadService Operations
Name
Description

LeadServiceRetireLead

Retires a lead.

LeadServiceCreateLead

Creates a lead.

LeadServiceRejectLead

Rejects a lead.

LeadServiceResponseToLead

Converts response to leads.

LeadServiceConvertLeadToOpty

Converts lead to an opportunity.

LeadServiceUpdateLead

Updates a lead.

Request Message Description: LeadServiceRetireLead

This method is used to assign leads. It accepts the input parameters in a property set. For a description of this request message, see Table 231.

Table 231. Request Message Description: LeadServiceRetireLead
Node
Description
Type

LeadId

Required. The ID of the lead to be retired.

String

ReasonCode

Required The reason code for retiring the lead.

String

Comments

Comments for retiring (if any).

String

Response Message Description: LeadServiceRetireLead

For a description of this response message, see Table 232.

Table 232. Response Message Description: LeadServiceRetireLead
Node
Description
Type

ReturnVal

Error code values are OK or NOTOK.

String

Request Message Description: LeadServiceCreateLead

For a description of this request message, see Table 233.

Table 233. Request Message Description: LeadServiceCreateLead
Node
Description
Type

Lead IO

Required. An instance of the integration object Lead IO.

Integration Object

Response Message Description: LeadServiceCreateLead

For a description of this response message, see Table 234.

Table 234. Response Message Description: LeadServiceCreateLead
Node
Description
Type

Error Message

Error message (if any).

String

Success Flag

Y or N.

String

Lead Id

ID of the lead generated as a result of the lead creation.

String

Request Message Description: LeadServiceRejectLead

This method is used to reject a lead. The lead ID is retained, along with a reject comments code, a reject reason code. Optionally an owner ID can be passed to whom the lead will be assigned. For a description of this request message, see Table 235.

Table 235. Request Message Description: LeadServiceRejectLead
Node
Description
Type

LeadId

Required. The ID of the lead to be rejected.

String

OwnerId

Optional.

String

ReasonCode

Reason code for rejecting the lead.

String

Comments

Comments (if any).

String

Response Message Description: LeadServiceRejectLead

For a description of this response message, see Table 236.

Table 236. Response Message Description: LeadServiceRejectLead
Node
Description
Type

ReturnVal

Error code values are OK or NOTOK.

String

Request Message Description: LeadServiceResponseToLead

For a description of this request message, see Table 237.

Table 237. Request Message Description: LeadServiceResponseToLead
Node
Description
Type

Response Id

Required. The ID of the response to be converted to lead.

String

Response Message Description: LeadServiceResponseToLead

For a description of this response message, see Table 238.

Table 238. Response Message Description: LeadServiceResponseToLead
Node
Description
Type

Error Message

Error message (if any).

String

Success Flag

Y or N.

String

Lead Id

The ID of the lead created from the response.

String

Request Message Description: LeadServiceConvertLeadToOpty

For a description of this request message, see Table 239.

Table 239. Request Message Description: LeadServiceConvertLeadToOpty
Node
Description
Type

LeadId

Required. The ID of the lead to be converted.

String

Contact Id

The contact ID of the lead.

String

Account Id

The account ID of the lead.

String

Response Message Description: LeadServiceConvertLeadToOpty

For a description of this response message, see Table 240.

Table 240. Response Message Description: LeadServiceConvertLeadToOpty
Node
Description
Type

Error Message

Error message (if any).

String

Success Flag

Y or N.

String

Opty Id

The ID of the opportunity created.

String

Request Message Description: LeadServiceUpdateLead
This method is used to update leads. It accepts input parameters in a property set. For a description of this request message, see Table 241.
Table 241. Request Message Description: LeadServiceUpdateLead
Node
Description
Type

Lead IO

Required. An instance of the integration object Lead IO.

Integration Object
Response Message Description: LeadServiceUpdateLead

For a description of this response message, see Table 242.

Table 242. Response Message Description: LeadServiceUpdateLead
Node
Description
Type

Error Message

Error message (if any).

String

Success Flag

Y or N.

String

LeadService Application Interface

This topic describes the application objects called by this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see Table 243.

Table 243. LeadService Service Object
Name
Boundary Object Type

Response To Lead Conversion

Workflow

Lead To Opty Conversion

Workflow

Data Object (Integration Object)

For a description of data objects for this Web service, see Table 244.

Table 244. LeadService Data object
Siebel Repository Name
External Name

Lead IO

Lead

Example Package for LeadService

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request (LeadServiceRetireLead)

See the following file to view the sample code:

...\LeadService\LeadService_RetireLead_request.xml

Response (LeadServiceRetireLead)

See the following file to view the sample code:

...\LeadService\LeadService_RetireLead_response.xml

Request (LeadServiceCreateLead)

See the following file to view the sample code:

...\LeadService\LeadService_CreateLead_request.xml

Response (LeadServiceCreateLead)

See the following file to view the sample code:

...\LeadService\LeadService_CreateLead_response.xml

Request (LeadServiceRejectLead)

See the following file to view the sample code:

...\LeadService\LeadService_RejectLead_request.xml

Response (LeadServiceRejectLead)

See the following file to view the sample code:

...\LeadService\LeadService_RejectLead_response.xml

Request (LeadServiceResponseToLead)

See the following file to view the sample code:

...\LeadService\LeadService_ResponseToLead_request.xml

Response (LeadServiceResponseToLead)

See the following file to view the sample code:

...\LeadService\LeadService_ResponseToLead_response.xml

Request (LeadServiceConvertLeadToOpty)

See the following file to view the sample code:

...\LeadService\LeadService_ConvertToOpty_request.xml

Response (LeadServiceConvertLeadToOpty)

See the following file to view the sample code:

...\LeadService\LeadService_ConvertToOpty_response.xml

Request (LeadServiceUpdateLead)

See the following file to view the sample code:

...\LeadService\LeadService_UpdateLead_request.xml

Response (LeadServiceUpdateLead)

See the following file to view the sample code:

...\LeadService\LeadService_UpdateLead_response.xml

Interface Description (WSDL) for LeadService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LeadService\Lead.wsdl

      
Siebel CRM Web Services Reference Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.