Professional Documents
Culture Documents
Version 5
(CRM OnDemand Release 10)
November 2005
Siebel Systems, Inc., 2207 Bridgepointe Parkway, San Mateo, CA 94404
Copyright © 2005 Siebel Systems, Inc.
All rights reserved.
Printed in the United States of America
No part of this publication may be stored in a retrieval system, transmitted, or reproduced in any way,
including but not limited to photocopy, photographic, magnetic, or other record, without the prior
agreement and written permission of Siebel Systems, Inc.
Siebel, the Siebel logo, UAN, Universal Application Network, Siebel CRM OnDemand, and other Siebel
names referenced herein are trademarks of Siebel Systems, Inc., and may be registered in certain
jurisdictions.
Other product names, designations, logos, and symbols may be trademarks or registered trademarks of
their respective owners.
PRODUCT MODULES AND OPTIONS. This guide contains descriptions of modules that are optional and
for which you may not have purchased a license. Siebel’s Sample Database also includes data related to
these optional modules. As a result, your software implementation may differ from descriptions in this
guide. To find out more about the modules your organization has purchased, see your corporate
purchasing agent or your Siebel sales representative.
U.S. GOVERNMENT RESTRICTED RIGHTS. Programs, Ancillary Programs and Documentation, delivered
subject to the Department of Defense Federal Acquisition Regulation Supplement, are “commercial
computer software” as set forth in DFARS 227.7202, Commercial Computer Software and Commercial
Computer Software Documentation, and as such, any use, duplication and disclosure of the Programs,
Ancillary Programs and Documentation shall be subject to the restrictions contained in the applicable
Siebel license agreement. All other use, duplication and disclosure of the Programs, Ancillary Programs
and Documentation by the U.S. Government shall be subject to the applicable Siebel license agreement
and the restrictions contained in subsection (c) of FAR 52.227-19, Commercial Computer Software -
Restricted Rights (June 1987), or FAR 52.227-14, Rights in Data—General, including Alternate III (June
1987), as applicable. Contractor/licensor is Siebel Systems, Inc., 2207 Bridgepointe Parkway, San
Mateo, CA 94404.
Proprietary Information
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 3
Contents ■
4 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Contents ■
Delete 148
Insert 149
InsertOrUpdate 150
QueryPage 151
Update 156
Service API Calls 157
GetListOfValues 158
GetMapping 159
SetPasswordAPI 159
Index
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 5
Contents ■
6 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
1 What’s New in This Release
Siebel Web Services OnDemand Guide contains new and previously released material.
Table 1. New Product Features in Siebel Web Services OnDemand Guide, Version 5
(CRM OnDemand Release 10)
Topic Description
“About Parent-Child Relationships” The matrix table that details parent child relationships has
on page 14 been removed. This information is now contained in the
section that details each parent service and child component.
“Methods Called by the OnDemand The table that details the methods called by each service has
Objects” on page 15 been removed. This information is now contained in the
section that details each parent section.
“Logging Out of the XML API Extra information about logging out of the XML API session
Session” on page 21 has been added.
“Parent Objects” on page 33 Information on parent services of, child components of and
methods called by each service has been included for each
parent service.
“Account” on page 34 The revenue child component has been added to the account
service.
“Contact” on page 60 The revenue child component has been added to the contact
service.
“CustomObject1” on page 75 The CustomObject1 service is a new service that has been
added for this release, and is described in this section.
“CustomObject2” on page 83 The CustomObject2 service is a new service that has been
added for this release, and is described in this section.
“Dealer” on page 91 The dealer service is a new service that has been added for
this release, and is described in this section.
“Service Request” on page 122 A new method, ServiceRequestDelete, has been added to the
Service Request service.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 7
What’s New in This Release ■
Table 1. New Product Features in Siebel Web Services OnDemand Guide, Version 5
(CRM OnDemand Release 10)
Topic Description
“QueryPage” on page 151 A new parameter, UseChildAnd, has been added to all
QueryPage calls.
“GetMapping” on page 159 This is a new section that describes the GetMapping method.
8 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
2 Overview of Web Services
OnDemand
This chapter provides an overview of Siebel CRM OnDemand’s support for Web services. It contains
the following sections:
■ Extensible Markup Language (XML): XML defines the structure and content of Web services. The
OnDemand Web Services objects and methods are defined using XML.
■ Web Services Description Language (WSDL): This is an XML-formatted language that is used to
describe the Web service’s capabilities, which allows applications to communicate effectively. The
WSDL file is an XML file that defines the objects and methods.
■ Simple Object Access Protocol (SOAP): SOAP is used to send Web services messages. Web
services messages are sent between the customer implementation of Web services and the SOAP
handler on the Siebel Web Server.
■ SOAP Handler: This handler listens for incoming SOAP messages and invokes upon the
implementation (detailed below). It is also used to transfer the response back to the Web client.
■ Implementation: This is the actual implementation of the Web service that provides the core
functionality. This back-end implementation of the Web service is implemented in an Enterprise
Java Bean (EJB) file.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 9
Overview of Web Services OnDemand ■ About Web Services
Figure 1 shows how the Web Services Toolkit interacts with the OnDemand database. The customer
uses the Web Services Toolkit (WSDLs) to define the objects and methods that are contained in the
OnDemand Hosted Service. The customer application communicates with OnDemand over the
Internet using the secure HTTPS protocol. It invokes the Web services implementation contained in
the OnDemand Hosted Service. The Web services implementation is used to create, update, delete,
or modify the objects that reside in the OnDemand database.
■ Integrations of CRM and back-office applications. You can retrieve real-time sales,
marketing, and service information from Siebel CRM OnDemand and use it in financial and other
back-office applications. For example, you can retrieve information about recently closed
opportunities through the Web services interface and insert this information into an order entry
system that has a Web services user interface. In addition, you can store information from back-
office applications in Siebel CRM OnDemand for instant access by end users, visible in custom
fields on any Siebel CRM OnDemand page.
10 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Overview of Web Services OnDemand ■ About Web Services
■ Web-based portal applications. You can create customized Web-based applications using
Active Server Pages (ASPs), Java Server Pages (JSPs), or similar Web technology that accesses
Siebel CRM OnDemand through the Web services interface. For example, a Siebel CRM
OnDemand customer can deploy a customized Web form on its corporate Web site, allowing
visitors to enter requests for more information. The application creates new lead records in Siebel
CRM OnDemand for these requests through the Web services interface. Another Web page can
allow visitors to browse through solutions to common problems stored in Siebel CRM OnDemand
and retrieved in real time through the Web services interface.
■ Custom add-on modules. Customers can also extend Siebel CRM OnDemand functionality. For
example, a company may create a custom add-on module to streamline its unique quote creation
process, or a company may create additional utilities to perform mass data cleanup operations.
These modules access data in Siebel CRM OnDemand directly through the Web services interface.
OnDemand administrators and end users can run these modules while concurrently accessing the
Siebel CRM OnDemand user interface.
■ All communications are encrypted with SSL for security (minimum 128-bit).
■ Access is session-based, requiring authorization with a valid Siebel CRM OnDemand user name
and password.
■ The same data visibility and access capabilities that apply to users in the Siebel CRM OnDemand
hosted service are applied to users connected through the Web services interface. Data visibility
and access are restricted by the role that your company assigns. Permissions are checked for
every data access.
■ A full audit trail of Web services activity is available through Siebel CRM OnDemand's
Administration pages. These pages display both current and historical usage statistics.
■ A number of other proprietary solutions protect the system against malicious use of the Web
services interface. These solutions are constantly reviewed and improved as new technologies
and techniques become available.
The system creates a session with a standard HTTPS request to establish a connection with Siebel
CRM OnDemand through the Web services interface. A client creates a new session with the Login
operation and closes it with the Logoff operation. When a session is created, the system provides an
encrypted session identifier to the client. Security is maintained by the client including the session
identifier with each request during that session.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 11
Overview of Web Services OnDemand ■ Web Services and the OnDemand Objects
The OnDemand objects provide a basis for customers to perform integration with OnDemand based
on SOAP technology. Table 2 details the OnDemand parent and child objects that are available
through OnDemand Web Services. For more information about parent-child relationships, see “About
Parent-Child Relationships” on page 14.
Object Description
“Account” on page 34 Stores information on companies with which your organization has a
(P) relationship, that is, customers, prospects, partners, and competitors.
“Activity” on page 48 Stores information on an activity that a user must carry out — for
(P) example, a call-back activity for an account. When an activity is created,
the end user must set the display field explicitly to Task or Appointment.
“Contact” on page 60 Stores information on individuals with whom your organization has a
(P) relationship.
“Current User” on Stores information on the user who is currently logged in to the
page 73 (P) OnDemand system.
“Household” on Stores financial details about a group of contacts that live in the same
page 93 household.
“Lead” on page 98 (P) Stores information on a company or individual with whom an opportunity
is created and worked.
12 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Overview of Web Services OnDemand ■ Web Services and the OnDemand Objects
Object Description
“LOV” on page 102 (P) Stores information on a list of values for a specified picklist.
“Portfolio” on page 113 Stores information on the collection of financial services that you may
(P) provide to an account.
“Product” on page 117 Stores information on a product or service that your company provides to
(P) its customers.
“Product Category” on Stores information on groups of products that are related to each other.
page 120 (P)
“Solution” on page 127 Stores information on solutions to customer problems or service requests.
(P)
“Territory” on page 130 Stores information about the territory for which a user is responsible.
(P)
“User” on page 132 (P) Stores information on all the users of the system.
“Vehicle” on page 137 Stores information on vehicles that may be sold to accounts or contacts.
(P)
“Address” on page 142 Stores information on the different addresses that are associated with
(C) accounts and contacts.
“Asset” on page 142 Stores information on the assets held by your accounts — for example,
(C) the products that an account has purchased.
“Audit Trail” on Stores information about how a service request object is modified from
page 143 (C) the moment that it created until a solution for the service request has
been found.
“Login History” on Stores information about currently logged in user such as the amount of
page 143 (C) times that the user has logged in, and the dates and times on which the
current user logged in.
“Multiple Contact Stores information on the different roles that a contact can hold within an
Roles” on page 144 (C) account.
“Note” on page 144 (C) Stores extra information (as a note) on a parent object.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 13
Overview of Web Services OnDemand ■ Web Services and the OnDemand Objects
Object Description
“Quota” on page 145 Stores information about the sales targets of, and sales made by the
(C) current user.
“Revenue” on page 145 Stores information about the product revenue for a particular opportunity.
(C)
“Related Account” on Stores information on an account that has a relationship with the parent
page 145 (C) account in question.
“Related Contact” on Stores information on an contact that has a relationship with the parent
page 145 (C) contact in question.
“Team” on page 146 Stores information on the team that is assigned to a particular account or
(C) contact.
These parent-child relationships can be one-to-many or many-to-many. For example, a lead may be
associated with a particular account, but an account may have many leads associated with it. In this
case, the relationship between the account and its leads may be thought of as a one-to-many parent-
child relationship.
Other relationships may be many-to-many, meaning that many children may be associated with
many parents. For example, a contact may be associated with several opportunities, or an
opportunity may have several contacts associated with it. In this case, the relationship between
contacts and their opportunities may be thought of as a many-to-many parent-child relationship. The
parent-child relationship between contacts and opportunities may be treated with either the
opportunity as the parent with contacts as children, or with the contact as the parent and the
opportunities as children.
14 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Overview of Web Services OnDemand ■ Web Services and the OnDemand Objects
Insert New parent New child Error Use child Not applicable
instance instance instance
It is only possible to query for a particular record or update a particular record in a table, if the values
of all the fields in any user key subset is known. Any valid group of user keys can uniquely identify
the record that a user wants to query or update. For example, the RowId, IntegrationId, or
ExternalSystemId field of an object instance uniquely identifies a record, and the object table can be
queried using that field as the user key.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 15
Overview of Web Services OnDemand ■ Web Services and the OnDemand Objects
In some instances, the RowId, IntegrationId, or ExternalSystemId of a record may not be known,
but its name, description, or other unique identification information may be known. In these cases,
if a user key for a particular record is defined to be a subset of fields whose values are known, the
record can be successfully updated using this user key. For example, for a Note child object, the
Subject and Description fields can be used in conjunction with each other to determine whether the
record is unique or not. Such a combination is not guaranteed to provide complete uniqueness, but
it may be used to query for uniqueness.
Generally, a subset of the record’s fields are used as a user key. However, one field on its own may
also act as a user key, depending on whether the field can identify the record as unique. Each user
key group can be used independently to identify a record. The user keys for each object are detailed
for each object in Chapter 4, “OnDemand Objects Exposed Through Web Services.”
A list of pick map fields, and the fields that they map to, are detailed in “Parent Objects” on page 33
for each object.
16 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Overview of Web Services OnDemand ■ Web Services and the OnDemand Objects
Audit Fields
Audit fields on an object provide information about who created an instance of the object, when it
was created, who has updated an instance of the object, and when it was updated. All objects, both
parent and child level, exposed by the Web services API contain the read-only Audit fields contained
in Table 4.
CreatedBy This field is a combination of the full name of the person that created this
instance of the object, and the date on which the instance was created. This
information is contained within the field in the following format:
ModifiedBy This field is a combination of the full name of the person that modified this
instance of the object, and the date on which the instance was modified. This
information is contained within the field in the following format:
ModifiedById The Row ID of the user that last modified the record.
ModifiedDate The DateTime stamp of when the record was last modified.
2 Click Advanced.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 17
Overview of Web Services OnDemand ■ Field Types Supported by OnDemand
■ A name ending in the suffix Id is usually a key field such as primary key, foreign key, or user key
Id. It can usually be treated as a unique text string.
■ Fields with names containing Date or Time, such as LastUpdated, DueDate, StartTime, or
EndTime may be date fields. The format for these fields is determined by the user’s online
preferences settings.
■ Phone number fields can be treated as numeric phone numbers or as plain text.
■ Other numeric fields such as currency, size, revenue, or probability can be treated as integer,
floating point, or text fields depending on the application.
MM/DD/YYYY hh:mm:ss
18 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
3 Getting Started with Web
Services
This chapter provides an overview of how to get started with Siebel CRM OnDemand Web Services
and contains the following sections:
1 Request Web Services Integration. For security reasons, this capability is not automatically
enabled for OnDemand customers. On request, a Siebel CRM OnDemand Customer Care
representative enables the Web Services OnDemand Integration capability for your company.
2 Download WSDL files. The customer's designated OnDemand Administrator accesses the Web
Services Administration page in Siebel CRM OnDemand. The Administrator downloads Web
Service Description Language (WSDL) files that have been published for the desired Siebel CRM
OnDemand entities.
3 Incorporate WSDL files. The company incorporates the WSDL files into its Web services
development environment—for example, by generating Java or C# (C Sharp) proxy classes.
4 Establishing and Managing the XML API Session. A Web services-enabled client, including
a client application written in any language that interacts with the Web services framework,
establishes a secure session with Siebel CRM OnDemand. Throughout this session, the client
interacts with the published OnDemand Web Service entities to perform data retrieval,
modification, creation, and deletion operations. OnDemand and the client format requests and
resulting data as standard XML/SOAP messages. For more information, see “Establishing and
Managing the XML API Session” on page 19.
■ Clients must make explicit login and logout calls in their code to manage the session.
■ The login step returns an HTTP cookie that must be used for making additional requests.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 19
Getting Started with Web Services ■ Establishing and Managing the XML API Session
■ A session remains active until the user explicitly logs off or until the session times out.
Web services session management service is HTTP-based. Session management in Siebel CRM
OnDemand is based on a session ID, JSESSIONID, contained in HTTP Session Cookies. The session
ID is critical to successful session generation and maintenance of a SOAP transaction. OnDemand
Web Services enable session management by first creating a session using the login call, which is
then referenced in any subsequent SOAP operations.
In a Siebel SOAP session, the session ID may be referenced in one of these two ways (after it has
been created in a login request):
■ It may be attached as a parameter to the URL request line. When a session ID is present in the
URL line, it is identified by the string jsessionid in lowercase, followed by the exact session ID,
which is coded using URL syntax.
■ It may be part of the cookie header line. When a session ID is referenced as a cookie, a cookie
header line must appear in the SOAP request with the name JSESSIONID=. In this case, the
session ID appears in uppercase, and the value of the cookie is exactly the same as the session
ID received from the login request.
SOAP operations will not work if a Siebel Session ID is not present in one of these ways.
When a login request is made, the session ID will be returned as a cookie in the response to the
request. The client is responsible for extracting this session ID and using it throughout the session.
If the session times out for any reason, the error returned will say the session is not valid and the
client must then request a new session. In this case no explicit logoff is required.
The logoff operation is considered one of the operations for a session, so the session ID must be
present in the logoff request. However, only the cookie version is accepted in the logoff request.
The OnDemand Web Service interface supports the following three types of functions:
https://secure.crmondemand.com/Services/Integration?command=login
NOTE: The term login is case sensitive. The protocol https indicates the use of the SSL protocol.
Login input. The input to Login is provided in the URL parameters and the HTTP headers, as follows:
■ The only URL parameter to be set is command. This parameter value is login.
20 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Getting Started with Web Services ■ Establishing and Managing the XML API Session
■ Two HTTP headers, UserName and Password, must be set with the appropriate values for your
system. For example:
UserName: johndoe@email.com
Password: mypass
■ A session cookie, jsessionid. The client must use this cookie when submitting subsequent
requests, including logoff requests.
■ A status code of 200, if the session does not encounter any errors. This indicates that the request
succeeded.
https://secure.crmondemand.com/Services/Integration/<EntityName>
where <EntityName> is the name of the relevant OnDemand entity. The system determines this
OnDemand entity from the contents of the SOAP request.
Integration request input. The jsessionid returned to the client during login must be included with
the request. The request must contain the jsessionid either as a cookie or as a URL parameter, as
follows:
https://secure.crmondemand.com/Services/Integration/<EntityName>;
jsessionid=xyZ12489w3482413
The Web service input is provided as a SOAP command in the body of the HTTP POST request.
Integration request output. The properties returned by the server populate the response headers
and the response body. The following table shows the top-level properties that specify key properties
of the HTTP response.
Property Comments
HttpStatus Status code returned in the response. If no value is provided, the response
is given the value 200 (indicating success).
Content-Type Content type returned in the response. If no value is provided, the response
is given the value text/xml.
https://secure.crmondemand.com/Services/Integration?command=logoff;
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 21
Getting Started with Web Services ■ Establishing and Managing the XML API Session
Logoff input. The jsessionid returned to the client during login must be included with the request
as a cookie with the same name. There are no other URL parameters or HTTP headers, and there is
no HTTP body. The jsessionid returned to the client during login must be included with the request.
The request must contain the JSESSIONID as a cookie. It may not be passed in as a URL parameter.
Logoff output. Logoff has no output. If the session does not encounter any errors, the status code
of the response is 200. This indicates that the request succeeded.
Additional Logoff
The jsessionid can be included in the URL instead of a cookie if the user wants. The following URL is
what the user would use, where XXXX is the jsessionid.
https://secure.crmondemand.com/Services/Integration;jsessionid=XXXX?command=logoff
The upper limit on the number of open sessions per organization is based on the number of licensed
users within an organization. The system applies the following formula: If X represents the number
of users in an organization, then the organization's session quota is 2X + 10.
If traffic reaches the maximum number of permitted sessions, the following error message is
provided as a response to subsequent attempts to establish a session:
This means that an end user will not be able to log on until some other sessions have ended.
■ A user may perform long-running operations on the server that result in complex and long-
running queries on the database.
■ A user may perform constant operations on the server that constantly use resources.
22 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
Rate limiting can alleviate the previous problems to some extent. OnDemand applies a restriction to
each session to limit the number of requests per second that clients can make. The rate limit is set
to twenty requests per second.
If the rate limit is exceeded, the following error message is provided to subsequent SOAP requests:
The maximum rate of requests was exceeded. Please try again in <waitTime> ms.
Session Timeouts
Web services sessions will time out after 5 minutes if there is no activity on the session.
PageSize method argument cannot be greater than 100, specified by the server
parameter ‘MaximumPageSize’.
A response will never return more than the specified number of records for a parent object in a
request.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 23
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
Sample VB Code
The following sample is compatible with Visual Studio, Visual Basic 6.0.
' Declarations used to perform http internet communications from Visual Basic.
24 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
' Adds one or more HTTP request headers to the HTTP request handle.
' Define a function or sub to contain the login steps as defined here.
"Password: userpassword"
headerSize = Len(netHeaders)
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 25
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
' This will be the value to use for the rest of the session.
"Cookie: JSESSIONID=abc123:-1"
/*
* log on to a web services session at the passed in service provider location using
* the passed in credentials. return a session id string that can be used in later
* @param userName - OnDemand user name (email address) of the user we are logging
* in as
*/
try
26 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
wsConnection.setUseCaches(false);
// wsConnection.setDoOutput(true);
// set some http headers to indicate the username and password we are using to
logon
wsConnection.setRequestProperty("UserName", userName);
wsConnection.setRequestProperty("Password", password);
wsConnection.setRequestMethod("GET");
if (wsConnection.getResponseCode() == HttpURLConnection.HTTP_OK)
sessionString = getCookieFromHeaders(wsConnection);
setSessionIdFromCookie(sessionString);
catch (Exception e)
return sessionString;
/*
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 27
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
* log off an existing web services session, using the sessionCookie information
* @param sessCookie - cookie string that indicates our sessionId with the WS provider
*/
try
wsConnection.setUseCaches(false);
wsConnection.setRequestProperty("Cookie", sessionCookie);
wsConnection.setRequestMethod("GET");
if (wsConnection.getResponseCode() == HttpURLConnection.HTTP_OK)
// showResponseHttpHeaders(wsConnection);
catch (Exception e)
28 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
/*
* given a successful logon response, extract the session cookie information
* @return the session cookie string from the OnDemand WS session or FAIL if not found*
*/
String headerName;
headerName = wsConnection.getHeaderFieldKey(i);
// found the Set-Cookie header (code assumes only one cookie is being set)
headerValue = wsConnection.getHeaderField(i);
break;
return headerValue;
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 29
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
C# Code Sample
The following is a code sample for logging in and logging off using C# (C Sharp):
using System;
using System.Net;
using System.IO;
namespace WebServiceHandler
try
HttpWebResponse myResponse;
myRequest.Method = "GET";
myRequest.Headers["UserName"] = userName;
myRequest.Headers["Password"] = password;
myResponse = (HttpWebResponse)myRequest.GetResponse();
Stream sr = myResponse.GetResponseStream();
30 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
// retrieve session id
if (headers[i].StartsWith("JSESSIONID"))
sep[0] = '=';
SessionID = headers[i].Split(sep)[1];
break;
sr.Close();
myResponse.Close();
catch (Exception e)
return SessionID;
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 31
Getting Started with Web Services ■ Code Samples for Logging In and Logging Out
if (resp.StatusCode != System.Net.HttpStatusCode.OK)
32 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
4 OnDemand Objects Exposed
Through Web Services
This chapter contains reference information about the objects exposed through the Web Services
OnDemand API. There are a number of parent and child OnDemand objects exposed. These objects
enable access to data stored within an instance of CRM OnDemand.
For each of these objects, there are a number of methods that may be invoked in order to carry out
a task or function. For more information on these methods, see Chapter 5, “Web Services OnDemand
API Calls.”
■ “Parent Objects”
Parent Objects
The discussion of the Web services parent objects includes a description of each object, as well as
information on usage of the objects and relationships between objects. The fields on which an object
can be filtered and the field combinations for user key identification are also listed.
■ “Account” on page 34
■ “Activity” on page 48
■ “Campaign” on page 54
■ “Contact” on page 60
■ “CustomObject2” on page 83
■ “Dealer” on page 91
■ “Household” on page 93
■ “Lead” on page 98
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 33
OnDemand Objects Exposed Through Web Services ■ Parent Objects
NOTE: The lists of Filterable Fields and User Key combinations for the child components are offered
only as a guide as they may change before the WSDLs are published.
Account
The account object exposes the data stored in the OnDemand account object and its related child
components. The methods of the account object require a list (array) of account objects as an input
argument. This list of accounts identifies the records on which the operation is to be carried out. This
section outlines the details of the account object and its relationship to its child objects.
Child Components
Activity, Contact, Lead, Opportunity, Service Request, Address, Asset, Competitor, Multiple Contact
Roles, Note, Partner, Related Account, Revenue and Team
Methods Called
Table 5 details the methods called by the account service, and their names as defined on the service.
34 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Fields
Table 6 details the required and read-only fields for the account object.
AccountConcatField Read-only
CreatedBy Read-only
CreatedById Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
ModifiedDate Read-only
ModifiedById Read-only
ModifiedBy Read-only
CreatedDate Read-only
CreatedById Read-only
CreatedBy Read-only
RelatedAccountId Read-only
Revenue RevenueId Required
PartNumber Required
Revenue Required
ContactFullName Required
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 35
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 7 details the status key for the account object, and the child component on which this key
resides.
Account CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedById
ModifiedDate
AccountNote CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
AccountTeam CreatedBy
CreatedById
CreatedDate
Id
ModifiedBy
ModifiedById
ModifiedDate
36 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Activity CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
Asset CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
Competitor AccountCompetitorId
CompetitorExternalId
CompetitorId
CompetitorIntegrationId
CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 37
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Contact AccountId
ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
Lead AccountId
ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
LeadId
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
38 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Opportunity AccountId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
RelatedAccount AccountRelationshipId
CreatedByAndDate
CreatedByDate
CreatedById
ModifiedByAndDate
ModifiedById
ModifiedDate
Revenue CreatedBy
CreatedById
CreatedDate
ExternalId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
RevenueId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 39
OnDemand Objects Exposed Through Web Services ■ Parent Objects
ServiceRequest AccountId
ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
ServiceRequestId
Partner AccountPartnerId
CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
PartnerExternalId
PartnerId
PartnerIntegrationId
Updated
Table 8 details the pick map fields for the account object and the child objects on which they reside.
ParentAccountIntegrationId ParentAccountId
40 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
RelatedAccountIntegrationId RelatedAccountId
ContactIntegrationId ContactId
RelatedAccountIntegrationId RelatedAccountId
RelatedAccountIntegrationId RelatedAccountId
ProductExternalId ProductId
ProductIntegrationId ProductId
ProductCategory ProductCategoryId
ProductCategoryExternalId ProductCategoryId
ProductCategoryIntegrationId ProductCategoryId
Table 9 provides a list of the filterable fields for the child components of the account objects, and a
list of user key combinations for each child component. All parent fields on the account object are
filterable.
Table 9. Filterable Fields and User Key Fields on the Account Object’s Child Components
IntegrationId
ExternalSystemId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 41
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 9. Filterable Fields and User Key Fields on the Account Object’s Child Components
LastName
UserID
UserRole
AccountAccess
OpportunityAccess
ContactAccess
ModifiedDate
ModifiedByID
Owner
Subject
DueDate
Priority
Status
ExternalId ExternalId
IntegrationId IntegrationId
City
Country
ModifiedDate
Province
StateProvince
ZipCode
42 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 9. Filterable Fields and User Key Fields on the Account Object’s Child Components
Contract
Date
ModifiedDate
PartNumber
ProductCategory
Product
ProjectManager
PurchaseDate
Price
Quantity
SalesRep
SerialNumber
ShipDate
Status
Type
Warranty
AccountContactModifiedDate Id
ContactType
ContactFirstName
ContactId
ContactLastName
Id
JobTitle
Owner
RelationshipType
RelationshipModifiedDate
RelationshipModifiedById
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 43
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 9. Filterable Fields and User Key Fields on the Account Object’s Child Components
Lead Campaign Id
EstimatedCloseDate LeadId
Rating
Source
Status
LeadOwner
PotentialRevenue
ProductInterest
SalesPerson
LeadId
Id
ContactExternalId ContactIntegrationId
ContactIntegrationId ContactExternalId
ContactRole
ModifiedDate
Revenue Id
CloseDate
Forecast
ExpectedRevenue
Probability
Priority
ReasonWonLost
SalesStage
Status
OpportunityId
Id
44 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 9. Filterable Fields and User Key Fields on the Account Object’s Child Components
Comments RelatedAccountId
EndDate RelatedAccountExternalId
ModifiedDate RelatedAccountIntegrationId
RelatedAccountExternalId
RelatedAccountId
RelatedAccountIntegrationId
RelationshipRole
RelationshipStatus
RelationshipType
ReverseRelationshipRole
StartDate
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 45
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 9. Filterable Fields and User Key Fields on the Account Object’s Child Components
Description ProductId
ExternalId ProductExternalId
IntegrationId ProductIntegrationId
Forecast
Frequency
ModifiedDate
NumberOfPeriods
Product
ProductCategoryId
ProductCategoryExternalId
ProductCategoryIntegrationId
ProductExternalId
ProductId
ProductIntegrationId
PurchasePrice
Quantity
Revenue
RevenueId
StartCloseDate
Status
Type
46 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 9. Filterable Fields and User Key Fields on the Account Object’s Child Components
Area ServiceRequestId
Owner
Priority
Type
Cause
Source
Status
Id
ServiceRequestId
Table 10 details the list of value fields available for the account object.
Priority ACCOUNT_PRIORITY
Region TRAINING_LOC_REGION
CallFrequency PHMA_CALL_FREQUENCY
InfluenceType ACC_PRI_INFL_TYPE
Route PHMA_ROUTE
Status ACCOUNT_STATUS
MarketPotential PHMA_RATING
MarketingSegment PRIM_MARKET
Status PARTY_RELATIONSHIP_STATUS
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 47
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Status STATUS
Frequency LOV_FREQUENCY_TYPE
Table 11 details a number of account object fields that you must not use for customer integrations.
Field Name
CustomerAccountGroup
GroupTypeCode
InternalOrgFlag
For more information on the fields exposed through the account Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the account
object.
See Also
Contact
Activity
The activity object stores information on an activity that a user must carry out — for example, a call-
back activity for an account. When an activity is created, set the display field explicitly to Task or
Appointment.
Usage
Siebel OnDemand Web Services uses activities to organize, track, and resolve a variety of tasks, from
finding and pursuing opportunities to closing service requests. If a task requires multiple steps that
one or more people may carry out, activities greatly simplify the job. Activities can help:
48 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Parent Services
Account, Campaign, Contact, Lead, Opportunity and Service Request
Child Components
Contact and User
Methods Called
Table 12 details the methods called by the activity service, and their names as defined on the service.
Fields
Table 13 details the required and read-only fields for the activity object.
Table 13. Required and Read-Only Fields for the Activity Object
ActivityId Read-only
ContactFirstName Read-only
ContactLastName Read-only
LeadFirstName Read-only
LeadLastName Read-only
MedEdEventName Read-only
OpportunityName Read-only
FundRequest Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 49
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 13. Required and Read-Only Fields for the Activity Object
ContactFirstName Read-only
ContactLastName Read-only
ContactAccountId Read-only
ContactAccountName Read-only
ContactAccountLocation Read-only
ContactAccountIntegrationId Read-only
ContactAccountExternalSystemId Read-only
UserEmail Read-only
UserFirstName Read-only
UserLastName Read-only
UserRole Read-only
Activity ActivityId
CreatedBy
CreatedByAndDate
CreatedTimestamp
ExternalSystemId
IntegrationId
ModifiedBy
ModifiedByAndDate
ModifiedTimestamp
50 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Contact ActivityContactId
ContactIntegrationId
ContactExternalSystemId
ContactId
CreatedByAndDate
CreatedById
CreatedDate
ModifiedByAndDate
ModifiedById
ModifiedDate
User CreatedByAndDate
CreatedById
CreatedDate
Id
ModifiedByAndDate
ModifiedById
ModifiedDate
UserExternalId
UserIntegrationId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 51
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 15 details the pick map fields for the activity object and the child objects on which they reside.
AccountLocation AccountId
AccountExternalSystemId AccountId
AccountIntegration AccountId
Owner OwnerId
CampaignExternalSystemId CampaignId
CampaignIntegrationId CampaignId
CampaignName CampaignId
LeadExternalSystemId LeadId
LeadIntegrationId LeadId
MedEdEventExternalSystemId MedEdEventId
MedEdEventIntegrationId MedEdEventId
OpportunityExternalSystemId OpportunityId
OpportunityIntegrationId OpportunityId
ServiceRequestNumber ServiceRequestId
ServiceRequestExternalSystemId ServiceRequestId
ServiceRequestIntegrationId ServiceRequestId
FundRequestExternalSystemId FundRequestId
FundRequestIntegrationId FundRequestId
ContactIntegrationId ContactId
UserIntegrationId UserId
52 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 16 provides a list of the filterable fields for the child components of the activity objects, and a
list of user key combinations for each child component. All parent fields on the activity object are
filterable.
Table 16. Filterable Fields and User Key Fields on the Activity Object’s Child Components
IntegrationId
ExternalSystemId
ContactExternalId ContactExternalId
ContactIntegrationId ContactIntegrationId
ContactFirstName
ContactLastName
ContactAccountId
ContactAccountName
ContactAccountLocation
ContactAccountIntegrationId
ContactAccountExternalSystemId
ModifiedDate
UserExternalId UserIntegrationId
UserIntegrationId
UserEmail
UserFirstName
UserLastName
UserRole
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 53
OnDemand Objects Exposed Through Web Services ■ Parent Objects
AccountName ACCOUNT_ID
AccountLocation ACCOUNT_ID
AccountIntegrationId ACCOUNT_ID
AccountExternalSystemId ACCOUNT_ID
OpportunityName OPPORTUNITY_ID
ServiceRequestNumber SERVICE_REQUEST_ID
ServiceRequestIntegrationId SERVICE_REQUEST_ID
ServiceRequestExternalSystemId SERVICE_REQUEST_ID
DelegatedByExternalSystemId DELEGATED_ID
PrimaryContactIntegrationId PRIMARY_CONTACT_ID
PrimaryContactExternalSystemId PRIMARY_CONTACT_ID
MedEdEventIntegrationId MED_ED_EVENT_ID
MedEdEventExternalSystemId MED_ED_EVENT_ID
FundRequestExternalId FUND_REQUEST_ID
LeadIntegrationId LEAD_ID
LeadExternalSystemId LEAD_ID
CampaignIntegrationId CAMPAIGN_ID
CampaignExternalSystemId CAMPAIGN_ID
ActivitySubtype COD_TODO_SUBTYPE
ResolutionCode COD_RESOLUTION_CODE
For more information on the fields exposed through the activity Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the activity
object.
Campaign
The campaign object provides a mechanism for marketing products and services to customers and
prospects. The campaign object is the primary way in which new products and services are marketed
to customers and prospects.
54 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Parent Service
Lead
Child Components
Activity, Contact, Lead, Opportunity and Note
Methods Called
Table 18 details the methods called by the campaign service, and their names as defined on the
service.
Fields
Table 19 details the required and read-only fields for the campaign object.
Table 19. Required and Read-Only Fields for the Campaign Object
SourceCode Required
CreatedBy Read-only
CreatedByFullName Read-only
CreatedById Read-only
CreatedDate Read-only
LastUpdated Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 55
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Campaign CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
Activity CampaignId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
56 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
CampaignNote CampaignId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
Lead CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
Opportunity CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 57
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Recipient CampaignContactId
ContactExtrernalId
ContactIntegrationId
ContactId
CreatedByAndDate
CreatedById
CreatedDate
ModifiedByAndDate
ModifiedById
ModifiedDate
Table 21 details the pick map field for the campaign object.
Owner OwnerId
Table 22 provides a list of the filterable fields for the child components of the campaign objects, and
a list of user key combinations for each child component. All parent fields on the campaign object
are filterable.
Table 22. Filterable Fields and User Key Fields on the Campaign Object’s Child Components
IntegrationId
ExternalSystemID
58 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 22. Filterable Fields and User Key Fields on the Campaign Object’s Child Components
Owner
Subject
DueDate
Priority
Status
EstimatedCloseDate Description
Rating
Source
Status
LeadOwner
PotentialRevenue
ProductInterest
SalesPerson
Owner
Revenue
CloseDate
Forecast
ExpectedRevenue
Probability
Priority
ReasonWonLost
SalesStage
Status
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 59
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Status CAMPAIGN_STATE
ResponseStatus RESPONSE_STATUS
For more information on the fields exposed through the campaign Web service, go to the Web
Services Administration screen within the OnDemand application and generate the WSDL for the
campaign object.
See Also
Current User and Opportunity
Contact
The contact object stores information on individuals with whom your organization has a relationship.
It allows the user to store information on individuals who are external to your company, but who are
associated with the business process. Contacts stored in the OnDemand database may also be
associated with an account.
Parent Services
Account, Activity, Campaign, Household, Opportunity, Portfolio and Vehicle
Child Components
Activity, Lead, Opportunity, Service Request, Note, Related Contact, Revenue and Team
60 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Methods Called
Table 24 details the methods called by the contact service, and their names as defined on the service.
Fields
Table 25 details the required and read-only fields for the contact object.
Table 25. Required and Read-Only Fields for the Contact Object
LastName Required
ContactConcatField Read-only
ContactFullName Read-only
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
Manager Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
UserFirstName Read-only
UserLastName Read-only
UserRole Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 61
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 25. Required and Read-Only Fields for the Contact Object
ContactId Read-only
RelatedContactFirstName Read-only
RelatedContactLastName Read-only
PartNumber Required
Revenue Required
ContactFullName Required
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
62 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Activity CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
ContactNote ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 63
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Lead AccountId
CampaignId
ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
LeadId
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
Opportunity AccountId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
LeadId
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
64 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
RelatedContact ContactRelationshipId
CreatedByAndDate
CreatedByDate
CreatedById
ModifiedByAndDate
ModifiedByDate
ModifiedById
RelatedContactId
Revenue CreatedBy
CreatedById
CreatedDate
ExternalId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
RevenueId
ServiceRequest AccountId
ContactID
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
ServiceRequestId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 65
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Team ContactTeamId
CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
UserExternalSystemId
UserId
UserIntegrationId
Table 27 details the pick map fields for the contact object.
Owner AssignedToAlias
SourceCampaignName SourceCampaignId
ManagerExternalSystemId ManagerId
Contact Team UserExternalSystemId UserId
UserIntegrationId UserId
RelatedContactIntegrationId RelatedContactId
ProductExternalId ProductId
ProductIntegrationId ProductId
ProductCategory ProductCategoryId
ProductCategoryExternalId ProductCategoryId
ProductCategoryIntegrationId ProductCategory
66 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 28 provides a list of the filterable fields for the child components of the contact objects, and a
list of user key combinations for each child component. All parent fields on the contact object are
filterable.
Table 28. Filterable Fields and User Key Fields on the Contact Object’s Child Components
IntegrationId
ExternalSystemId
Owner
Subject
DueDate
Priority
Status
ExternalId ExternalId
IntegrationId IntegrationId
City
Country
ZipCode
StateProvince
Province
UserId
UserExternalSystemId
UserIntegrationId
UserFirstName
UserLastName
ContactAccess
UserRole
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 67
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 28. Filterable Fields and User Key Fields on the Contact Object’s Child Components
Lead Campaign
EstimatedCloseDate
Rating
Source
Status
LeadOwner
PotentialRevenue
ProductInterest
SalesPerson
LeadId
OpportunityId
Opportunity Opportunity
OpportunityId
Owner
Revenue
CloseDate
Forecast
ExpectedRevenue
Probability
Priority
ReasonWonLost
SalesStage
Status
Account
68 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 28. Filterable Fields and User Key Fields on the Contact Object’s Child Components
PersonalAddressName
AlternateCity
AlternateCountry
AlternateZipCode
AlternateStateProvince
AlternateAddress
AlternateAddress2
AlternateAddress3
Id
IntegrationId
AddressName
City
Country
ZipCode
StateProvince
Address
ShippingAddress2
RelatedContactExternalId
RelatedContactIntegrationId
RelationshipStatus
RelationshipType
StartDate
EndDate
Description
RelationshipRole
ReverseRelationshipRole
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 69
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 28. Filterable Fields and User Key Fields on the Contact Object’s Child Components
Description ExternalId
ExternalId IntegrationId
Forecast
Frequency
IntegrationId
ModifiedDate
NumberOfPeriods
Product
ProductId
ProductCategoryId
ProductCategory
ProductCategoryExternalId
ProductCategoryIntegrationId
ProductExternalId
ProductIntegrationId
PurchasePrice
Quantity
Revenue
RevenueId
Status
StartCloseDate
Type
70 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 28. Filterable Fields and User Key Fields on the Contact Object’s Child Components
Area
Owner
Priority
Type
Cause
Source
Status
ServiceRequestId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 71
OnDemand Objects Exposed Through Web Services ■ Parent Objects
LeadSource OCCAM_LEAD_SOURCE
MrMrs MR_MRS
BestTimeToCall FINCORP_CONTACT_CALL_TIME
CallFrequency PROF_CALL_CLASS
CurrentInvestmentMix VONDINS_INVESTMENT_MIX
Degree PROF_DEGREE
ExperienceLevel FINS_INVST_EXPR_CD
Gender SEX_MF
InvestmentHorizon FINS_INV_HORIZON
LifeEvent FIN_CON_LIFE_EVENTS
MaritalStatus MARITAL_STATUS
MarketPotential PHARMA_MARKET_POT
Objective FINCORP_INVESTOR_OBJECTIVES
OwnOrRent FIN_HOUSING_TYPE
PrimaryGoal FINS_GOALS
RiskProfile FINS_INVST_RISK_CD
Route PROF_ROUTE
Segment FIN_CONTACT_DEPARTMENT
Tier FIN_CON_VALUE_TYPE
Status CON_PARTY_RELATIONSHIP_STATUS
Status STATUS
Frequency LOV_FREQUENCY_TYPE
72 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 30 details a number of contact object fields that you must not use for customer integrations.
Table 30. Contact Object Fields That You Must Not Use
Field Name
PartyTypeCode
PartyUId
PersonUId
For more information on the fields exposed through the contact Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the contact
object.
Current User
The current user object stores information on the currently logged-in user.
Child Components
Login History and Quota
Methods Called
Table 31 details the method called by the current user service, and its name as defined on the
service.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 73
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Fields
Table 32 details the required and read-only fields for the current user object.
Table 32. Required and Read-Only Fields for the Current User Object
LastName Required
CreatedBy Read-only
ModifiedBy Read-only
Table 33 provides a list of the filterable fields for the child components of the current user objects,
and a list of user key combinations for each child component. All parent fields on the current user
object are filterable.
Table 33. Filterable Fields on the Current User Object’s Child Components
IntegrationId
ExternalSystemId
SourceIPAddress
SignInStatus
SignInTime
For more information on the fields exposed through the current user Web service, go to the Web
Services Administration screen within the OnDemand application and generate the WSDL for the
current user object.
See Also
User
74 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
CustomObject1
This service exposes the functionality of the CustomObject1 OnDemand object to external
applications.
NOTE: To download the CustomObject1 WSDL, you must be given access to the CustomObject1
object. If you do not have access to the CustomObject1 object, it will not be available to download
from the Web Services Administration screen or available to use the vertical Web service calls. For
assistance in gaining access to the CustomObject1 object, contact your Siebel CRM OnDemand
service provider.
Child Components
Account, Contact, CustomObject2, Opportunity, Portfolio and Team
Methods Called
Table 34 details the methods called by the CustomObject1 service, and their names as defined on
the service.
Fields
Table 35 details the required and read-only fields for the CustomObject1 object.
Table 35. Required and Read-Only Fields for the CustomObject1 Object
CustomObject1ExternalSystemID Required
CustomObject1IntegrationId Required
CustomObject1Id Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 75
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 35. Required and Read-Only Fields for the CustomObject1 Object
CObj1AccountCreatedDate Read-only
CObj1AccountModifiedById Read-only
CObj1AccountModifiedDate Read-only
Region Read-only
AccountType Read-only
CObj1ContactCreatedDate Read-only
CObj1ContactModifiedById Read-only
CObj1ContactModifiedDate Read-only
ContactFirstName Read-only
ContactLastName Read-only
ContactType Read-only
CObj1CustomObject2CreatedDate Read-only
CObj1CustomObject2ModifiedById Read-only
CObj1CustomObject2ModifiedDate Read-only
CustomObject2Id Read-only
CObj1OpportunityCreatedDate Read-only
CObj1OpportunityModifiedById Read-only
CObj1OpportunityModifiedDate Read-only
OpportunityName Read-only
Revenue Read-only
SalesStage Read-only
76 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 35. Required and Read-Only Fields for the CustomObject1 Object
CObj1PortfolioCreatedById Read-only
CObj1PortfolioCreatedDate Read-only
CObj1PortfolioModifiedById Read-only
CObj1PortfolioModifiedDate Read-only
Revenue Read-only
UserFirstName Read-only
UserLastName Read-only
CustomObject1 CustomObject1Id
ExternalSystemId
IntegrationId
CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
Account CustomObject1AccountId
CObj1AccountCreatedById
CObj1AccountCreatedDate
CObj1AccountModifiedById
CObj1AccountModifiedDate
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 77
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Contact CustomObject1ContactId
CObj1ContactCreatedById
CObj1ContactCreatedDate
CObj1ContactModifiedById
CObj1ContactModifiedDate
CustomObject2 CustomObject2Id
CObj1CustomObject2CreatedById
CObj1CustomObject2CreatedDate
CObj1CustomObject2ModifiedById
CObj1CustomObject2ModifiedDate
Opportunity OpportunityId
CObj1OpportunityCreatedById
CObj1OpportunityCreatedDate
CObj1OpportunityModifiedById
CObj1OpportunityCreatedDate
Portfolio PortfolioId
CObj1PortfolioCreatedById
CObj1PortfolioCreatedDate
CObj1PortfolioModifedById
CObj1PortfolioModifiedDate
Team CustomObject1TeamId
CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
78 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 37 details the pick map fields for the CustomObject1 object.
AccountIntegrationId AccountId
AccountName AccountId
ActivityExternalId ActivityId
ActivityIntegrationId ActivityId
ActivityName ActivityId
CampaignExternalId CampaignId
CampaignIntegrationId CampaignId
CampaignName CampaignId
ContactExternalId ContactId
ContactFirstName ContactId
ContactFullName ContactId
ContactIntegrationId ContactId
ContactLastName ContactId
CustomObject2ExternalId CustomObject2Id
CustomObject2IntegrationId CustomObject2Id
CustomObject2Name CustomObject2Id
CustomObject3ExternalId CustomObject3Id
CustomObject3IntegrationId CustomObject3Id
CustomObject3Name CustomObject3Id
DealerName DealerId
HouseholdExternalId HouseholdId
HouseholdIntegrationId HouseholdId
HouseholdName HouseholdId
LeadExternalId LeadId
LeadFirstName LeadId
LeadFullName LeadId
LeadIntegrationId LeadId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 79
OnDemand Objects Exposed Through Web Services ■ Parent Objects
OpportunityExternalId OpportunityId
OpportunityIntegrationId OpportunityId
OpportunityName OpportunityId
ParentExternalSystemId ParentId
ParentIntegrationId ParentId
PortfolioAccountNumber PortfolioId
ProductExternalId ProductId
ProductIntegrationId ProductId
ProductName ProductId
SolutionExternalId SolutionId
SolutionIntegrationId SolutionId
SolutionTitle SolutionId
ServiceRequestExternalId ServiceRequestId
ServiceRequestIntegrationId ServiceRequestId
ServiceRequestName ServiceRequestId
VIN VehicleId
Location AccountId
Name AccountId
IntegrationId ContactId
IntegrationId OpportunityId
IntegrationId PortfolioId
80 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
UserIntegrationId UserId
UserEmail UserId
Table 38 provides a list of the filterable fields for the child components of the CustomObject1 object,
and a list of user key combinations for each child component. All parent fields on the CustomObject1
object are filterable.
Table 38. Filterable Fields and User Key Fields on the CustomObject1 Object’s Child Components
ExternalSystemId
IntegrationId
AccountType ExternalSystemId
CObj1AccountModifiedById IntegrationId
CObj1AccountModifiedDate
ExternalSystemId
IntegrationId
Location
Name
Region
CObj1ContactModifiedById ExternalSystemId
CObj1ContactModifiedDate IntegrationId
ContactType
ExternalSystemId
IntegrationId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 81
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 38. Filterable Fields and User Key Fields on the CustomObject1 Object’s Child Components
CObj1CustomObject2ModifiedById ExternalSystemId
CObj1CustomObject2ModifiedDate IntegrationId
ExternalSystemId
IntegrationId
Name
Type
CObj1OpportunityModifiedDate ExternalSystemId
ExternalSystemId IntegrationId
IntegrationId
OpportunityId
CObj1PortfolioModfiedDate ExternalSystemId
ExternalSystemId IntegrationId
IntegrationId
PortfolioId
UserEmail UserExternalSystemId
UserExternalSystemId UserIntegrationId
UserId
UserIntegrationId
82 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
CustomObject2
This service exposes the functionality of the CustomObject2 OnDemand object to external
applications.
NOTE: To download the CustomObject2 WSDL, you must be given access to the CustomObject2
object. If you do not have access to the CustomObject2 object, it will not be available to download
from the Web Services Administration screen or available to use the vertical Web service calls. For
assistance in gaining access to the CustomObject2 object, contact your Siebel CRM OnDemand
service provider.
Child Components
Account, Contact, CustomObject1, Opportunity, Portfolio and Team
Methods Called
Table 40 details the methods called by the CustomObject2 service, and their names as defined on
the service.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 83
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Fields
Table 41 details the required and read-only fields for the CustomObject2 object.
Table 41. Required and Read-Only Fields for the CustomObject2 Object
CustomObject2ExternalSystemID Required
CustomObject2IntegrationId Required
CustomObject2Id Read-only
CObj2AccountCreatedById Read-only
CObj2AccountCreatedDate Read-only
CObj2AccountModifiedById Read-only
CObj2AccountModifiedDate Read-only
Region Read-only
ContactLastName Read-only
ContactType Read-only
CObj2ContactCreatedById Read-only
CObj2ContactCreatedDate Read-only
CObj2ContactModifiedById Read-only
CObj2ContactModifiedDate Read-only
CustomObject1 CObj2CustomObject1CreatedById Read-only
CObj2CustomObject1CreatedDate Read-only
CObj2CustomObject1ModifiedById Read-only
CObj2CustomObject1ModifiedDate Read-only
CustomObject1Id Read-only
84 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 41. Required and Read-Only Fields for the CustomObject2 Object
CObj2OpportunityCreatedById Read-only
CObj2OpportunityCreatedDate Read-only
CObj2OpportunityModifiedById Read-only
CObj2OpportunityModifiedDate Read-only
Name Read-only
Revenue Read-only
SalesStage Read-only
CObj2PortfolioCreatedById Read-only
CObj2PortfolioCreatedDate Read-only
CObj2PortfolioModifiedById Read-only
CObj2PortfolioModifiedDate Read-only
Revenue Read-only
UserFirstName Read-only
UserLastName Read-only
CustomObject2 CustomObject2Id
ExternalSystemId
IntegrationId
CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 85
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Account CustomObject2AccountId
CObj2AccountCreatedById
CObj2AccountCreatedDate
CObj2AccountModifiedById
CObj2AccountModifiedDate
Contact CustomObject2ContactId
CObj2ContactCreatedById
CObj2ContactCreatedDate
CObj2ContactModifiedById
CObj2ContactModifiedDate
CustomObject1 CustomObject1Id
CObj2CustomObject1CreatedById
CObj2CustomObject1CreatedDate
CObj2CustomObject1ModifiedById
CObj2CustomObject1ModifiedDate
Opportunity OpportunityId
CObj2OpportunityCreatedById
CObj2OpportunityCreatedDate
CObj2OpportunityModifiedById
CObj2OpportunityCreatedDate
Portfolio PortfolioId
CObj2PortfolioCreatedById
CObj2PortfolioCreatedDate
CObj2PortfolioModifedById
CObj2PortfolioModifiedDate
86 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Team CustomObject2TeamId
CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
Table 43 details the pick map fields for the CustomObject2 object.
AccountIntegrationId AccountId
AccountName AccountId
ActivityExternalId ActivityId
ActivityIntegrationId ActivityId
ActivityName ActivityId
CampaignExternalId CampaignId
CampaignIntegrationId CampaignId
CampaignName CampaignId
ContactExternalId ContactId
ContactFirstName ContactId
ContactFullName ContactId
ContactIntegrationId ContactId
ContactLastName ContactId
CustomObject1ExternalId CustomObject1Id
CustomObject1IntegrationId CustomObject1Id
CustomObject1Name CustomObject1Id
CustomObject3ExternalId CustomObject3Id
CustomObject3IntegrationId CustomObject3Id
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 87
OnDemand Objects Exposed Through Web Services ■ Parent Objects
HouseholdExternalId HouseholdId
HouseholdIntegrationId HouseholdId
HouseholdName HouseholdId
LeadExternalId LeadId
LeadFirstName LeadId
LeadFullName LeadId
LeadIntegrationId LeadId
LeadLastName LeadId
Owner OwnerId
OpportunityExternalId OpportunityId
OpportunityIntegrationId OpportunityId
OpportunityName OpportunityId
ParentExternalSystemId ParentId
ParentIntegrationId ParentId
PortfolioAccountNumber PortfolioId
ProductExternalId ProductId
ProductIntegrationId ProductId
ProductName ProductId
SolutionExternalId SolutionId
SolutionIntegrationId SolutionId
SolutionTitle SolutionId
ServiceRequestExternalId ServiceRequestId
ServiceRequestIntegrationId ServiceRequestId
ServiceRequestName ServiceRequestId
VIN VehicleId
IntegrationId AccountId
Location AccountId
Name AccountId
88 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
IntegrationId ContactId
IntegrationId OpportunityId
IntegrationId PortfolioId
UserIntegrationId UserId
UserEmail UserId
Table 44 provides a list of the filterable fields for the child components of the CustomObject2 object,
and a list of user key combinations for each child component. All parent fields on the CustomObject2
object are filterable.
Table 44. Filterable Fields and User Key Fields on the CustomObject2 Object’s Child Components
ExternalSystemId
IntegrationId
AccountType ExternalSystemId
CObj2AccountModifiedById IntegrationId
CObj2AccountModifiedDate
ExternalSystemId
IntegrationId
Location
Name
Region
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 89
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 44. Filterable Fields and User Key Fields on the CustomObject2 Object’s Child Components
CObj2ContactModifiedDate ExternalSystemId
ContactId IntegrationId
ContactType
ExternalSystemId
IntegrationId
CObj2CustomObject1ModifiedDate ExternalSystemId
CustomObject1Id IntegrationId
CustomObject1Name
ExternalSystemId
IntegrationId
Type
CObj2OpportunityModifiedDate ExternalSystemId
ExternalSystemId IntegrationId
IntegrationId
OpportunityId
ExternalSystemId IntegrationId
IntegrationId
PortfolioId
UserEmail UserExternalSystemId
UserExternalSystemId UserIntegrationId
UserId
UserIntegrationId
90 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Dealer
The dealer object stores information about dealerships in the automotive industry, for example, the
name of the dealership, the identity of the parent dealership, the site on which the dealership is
based, and so on. The dealer object does not have any parent services or child components.
NOTE: To download the Dealer WSDL, you must be given access to the Dealer object. If you do not
have access to the Dealer object, it will not be available to download from the Web Services
Administration screen or available to use the vertical Web service calls. For assistance in gaining
access to the Dealer object, contact your Siebel CRM OnDemand service provider.
Methods Called
Table 46 details the methods called by the dealer service, and their names as defined on the service.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 91
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Fields
All fields on the dealer object are filterable.
Table 47 details the required and read-only fields for the dealer object.
Table 47. Required and Read-Only Fields for the Dealer Object
DealerId Required
DealerIntegrationId Required
DealerExternalSystemID Required
DealerId Read-only
DealerType Read-only
Dealer CreatedBy
CreatedById
CreatedDate
DealerId
DealerIntegrationID
DealerExternalSystemId
ModifiedBy
ModifiedById
ModifiedDate
Table 49 details the pick map fields for the dealer object.
Owner OwnerId
ParentDealerExternalSystemId ParentDealerId
92 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
ParentDealerIntegrationId ParentDealerId
ParentDealerName ParentDealerId
ParentDealerSite ParentDealerId
ParentDealerName ParentDealerId
ParentDealerSite ParentDealerId
For more information on the fields exposed through the household Web service, go to the Web
Services Administration screen within the OnDemand application and generate the WSDL for the
household object.
Household
The household object allows you to define and record financial details about a group of contacts that
live in the same household, for example, parents, brothers, sisters, spouses, and so on. These details
include the assets of the household, the liabilities of the household, the net income of the household,
and so on.
NOTE: To download the Household WSDL, you must be given access to the Household object. If you
do not have access to the Household object, it will not be available to download from the Web
Services Administration screen or available to use the vertical Web service calls. For assistance in
gaining access to the Household object, contact your Siebel CRM OnDemand service provider.
Child Component
Contact
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 93
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Methods Called
Table 51 details the methods called by the household service, and their names as defined on the
service.
94 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Fields
Table 52 details the required and read-only fields for the household object.
Table 52. Required and Read-Only Fields for the Household Object
IntegrationID Required
ExternalSystemID Required
HouseholdId Read-only
PrimaryContactId Read-only
PrimaryContactExternalId Read-only
PrimaryContactIntegrationId Read-only
PrimaryContactFirstName Read-only
PrimaryContactLastName Read-only
Timezone Read-only
HouseholdCurrency Read-only
LastActivity Read-only
HeadDOB Read-only
TotalIncome Read-only
TotalAssets Read-only
TotalExpenses Read-only
TotalLiabilities Read-only
TotalNetWorth Read-only
RiskProfile Read-only
ExperienceLevel Read-only
InvestmentHorizon Read-only
CurrentInvestmentMix Read-only
Objective Read-only
PrimaryGoal Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 95
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 52. Required and Read-Only Fields for the Household Object
ContactExternalId Required
ContactIntegrationId Required
ContactFirstName Read-only
ContactLastName Read-only
ContactId Read-only
ContactMrMrs Read-only
Household CreatedBy
CreatedById
CreatedDate
ExternalSystemId
HouseholdId
IntegrationID
ModifiedBy
ModifiedById
ModifiedDate
Contact CreatedBy
CreatedById
CreatedDate
ContactId
ModifiedBy
ModifiedById
ModifiedDate
96 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 54 details the pick map fields for the household object.
ContactIntegrationId
Table 55 provides a list of the filterable fields for the child components of the household object, and
a list of user key combinations for each child component. All parent fields on the household object
are filterable.
Table 55. Filterable Fields and User Key Fields on the Household Object’s Child Components
IntegrationID
ExternalSystemID
ContactExternalId ContactExternalId
ContactIntegrationId ContactIntegrationId
ModifiedDate
RelationshipRole
Type HOUSEHOLD_TYPE
For more information on the fields exposed through the household Web service, go to the Web
Services Administration screen within the OnDemand application and generate the WSDL for the
household object.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 97
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Lead
The lead object stores information on a company or individual with whom an opportunity may be
created and worked. It allows the user to identify the companies that may be interested in a product
or service. Leads are usually generated as part of a marketing campaign.
Parent Services
Account, Campaign, Contact and Opportunity
Child Components
Activity and Campaign
Methods Called
Table 57 details the methods called by the lead service, and their names as defined on the service.
Fields
Table 58 details the required and read-only fields for the lead object.
Table 58. Required and Read-Only Fields for the Lead Object
FirstName Required
LastName Required
LeadOwner Required
ContactFullName Read-only
CreatedBy Read-only
CreatedById Read-only
98 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 58. Required and Read-Only Fields for the Lead Object
CreatedDate Read-only
LastUpdated Read-only
LeadConcatField Read-only
LeadFullName Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
Lead AccountId
CampaignId
ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 99
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Activity CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LeadId
ModifiedBy
ModifiedById
ModifiedDate
Table 60 details the pick map fields for the lead object.
Campaign CampaignId
OpportunityName OpportunityId
Owner OwnerId
AccountExternalSystemId AccountId
OpportunityExternalSystemId OpportunityId
ContactExternalSystemId ContactId
CampaignExternalSystemId CampaignId
100 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 61 provides a list of the filterable fields for the child components of the lead object, and a list
of user key combinations for each child component. All parent fields on the lead object are filterable.
Table 61. Filterable Fields and User Key Fields on the Lead Object’s Child Components
IntegrationId
ExternalSystemId
LeadFirstName and LeadLastName
Description
Owner
Subject
DueDate
Priority
Status
Country COUNTRY
MrMrs MR_MRS
Rating OCCAM_LEAD_RATING
Source OCCAM_LEAD_SOURCE
StateProvince STATE_ABBREV
Status OCCAM_LEAD_SOURCE
For more information on the fields exposed through the lead Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the lead object.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 10 1
OnDemand Objects Exposed Through Web Services ■ Parent Objects
LOV
The LOV object stores information on a list of values for a specified static picklist. Using the
GetListOfValues method with this object allows a user to return a list of values for a static drop-down
list. For example, if you want to get a list of all the possible types that an Activity can have, you use
the GetListOfValues method with the LOVType parameter set to TODO_TYPE. This returns all possible
values for the type of a Task.
There are three fields—OpportunitySalesStage, ContactTimeZone, and AccountIndustry—that are
not implemented as a standard LOV field. For this reason, the GetListOfValues method cannot be
used to return values for these fields.
Table 63 shows the fields for which LOVs are available for each object. This table also details the LOV
type for the field. The LOV type determines the items available in the picklist.
Table 63. Web Services Fields for Which LOVs Are Available
Priority ACCOUNT_PRIORITY
Region TRAINING_LOC_REGION
Type PRODUCT_TYPE
Operating Status
Status CAMPAIGN_STATE
LeadSource OCCAM_LEAD_SOURCE
MrMrs MR_MRS
102 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 63. Web Services Fields for Which LOVs Are Available
MrMrs MR_MRS
Rating OCCAM_LEAD_RATING
Source OCCAM_LEAD_SOURCE
StateProvince STATE_ABBREV
Status OCCAM_LEAD_STATUS
Priority ACCOUNT_PRIORITY
LeadSource OCCAM_LEAD_SOURCE
Probability PROB
ReasonWonLost REASON_WON_LOST
Status OPTY_STATUS
ProductType PROD_CD
BodyStyle AUTO_BODY_STYLE_TYPE
DoorStyle AUTO_DOORS_STYLE_TYPE
Engine AUTO_ENGINE_TYPE
Make OD_AUTO_MAKE_TYPE
Model OD_AUTO_MODEL_TYPE
Transmission AUTO_TRANSMISSION_TYPE
Trim OD_AUTO_TRIM_TYPE
Category PRODUCT_CATEGORY
PriceType UNIT_OF_MEASURE
SubType FINS_ASSET_PROD_CLASS_MLOV
TherapeuticClass THERAPEUTIC_CLASS
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 10 3
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 63. Web Services Fields for Which LOVs Are Available
Cause SR_SEVERITY
Priority SR_PRIORITY
Source SR_SOURCE
Status SR_STATUS
Type SR_TYPE
Publish SOLUTION_PUBLISH
Status SOLUTION_STATUS
Methods Called
Table 64 details the method called by the LOV service, and its name as defined on the service.
Opportunity
The opportunity object allows employees to identify and record a potential revenue-generating event
that has arisen with an account or contact. Opportunities can be generated from marketing
campaigns when leads indicate that they are interested in a product or service that has been offered.
Parent Services
Account, Campaign and Contact
Child Components
Activity, Contact, Lead, Product, Note and Revenue
104 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Methods Called
Table 65 details the methods called by the opportunity service, and their names as defined on the
service.
Fields
Table 66 details the required and read-only fields for the opportunity object.
Table 66. Required and Read-Only Fields for the Opportunity Object
CloseDate Required
OpportunityName Required
SalesStage Required
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
LastUpdated Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
OpportunityConcatField Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 10 5
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 66. Required and Read-Only Fields for the Opportunity Object
ProductCategoryId Read-only
ProductCategory Read-only
ProductPartNumber Read-only
ProductStatus Read-only
ProductType Read-only
OpportunityId Read-only
OpportunityName Read-only
OpportunityIntegrationID Read-only
OpportunityExternalSystemId Read-only
OpportunitySalesStage Read-only
OpportunityAccountId Read-only
OpportunityAccountName Read-only
OpportunityAccountLocation Read-only
OpportunityAccountExternalSystemId Read-only
OpportunityAccountIntegrationId Read-only
ContactFirstName Read-only
ContactLastName Read-only
106 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Opportunity AccountId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
Activity CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 10 7
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Contact AccountId
ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
Lead AccountId
ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
LastUpdated
LeadId
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
108 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
OpportunityNote CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
OpportunityId
Product CreatedBy
CreatedByDate
CreatedById
ExternalId
ProductRevenueId
IntegrationID
ModifiedBy
ModifiedById
ModifiedDate
Table 68 details the pick map fields for the opportunity object.
AccountExternalSystemId AccountId
Territory TerritoryId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 10 9
OnDemand Objects Exposed Through Web Services ■ Parent Objects
ProductExternalSystemId ProductId
ProductIntegrationId ProductId
ContactExternalSystemId ContactId
ContactIntegrationId ContactId
Owner OwnerId
Table 69 provides a list of the filterable fields for the child components of the opportunity objects,
and a list of user key combinations for each child component. All parent fields on the opportunity
object are filterable.
Table 69. Filterable Fields and User Key Fields on the Opportunity Object’s Child Components
IntegrationId
ExternalSystemId
Owner
Subject
DueDate
Priority
Status
ContactLastName
Owner
Id
110 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 69. Filterable Fields and User Key Fields on the Opportunity Object’s Child Components
Lead Campaign
EstimatedCloseDate
Rating
Source
Status
LeadOwner
PotentialRevenue
ProductInterest
SalesPerson
LeadId
OpportunityExternalSystemId OpportunityIntegrationId
OpportunitySalesStage
OpportunityAccountId
OpportunityAccountName
OpportunityAccountLocation
OpportunityAccountExternalSystemId
OpportunityAccountIntegrationId
ModifiedDate
ContactId
ContactExternalSystemId
ContactIntegrationId
Contract
OwnerId
Owner
SerialNumber
Revenue
ExpectedRevenue
Quantity
PurchasePrice
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 11 1
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 69. Filterable Fields and User Key Fields on the Opportunity Object’s Child Components
StartCloseDate
NumberOfPeriods
Frequency
Probability
Forecast
AssetValue
Premium
ShipDate
Status
Type
Warranty
ExternalId ExternalId
IntegrationId IntegrationId
ProductId
ProductName
ProductExternalSystemID
ProductionIntegrationId
ProductCategoryId
ProductCategory
ProductPartNumber
ProductStatus
ProductType
OpportunityId
OpportunityName
112 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 70 details the list of value fields available for the opportunity object.
Priority ACCOUNT_PRIORITY
Probability PROB
ReasonWonLost REASON_WON_LOST
Status OCCAM_LEAD_STATUS
Type UT_OPPTY_TYPE
Year YEAR
Make OD_AUTO_MAKE_TYPE
Model OD_AUTO_MODEL_TYPE
Probability % PROB
Status STATUS
TYPE REVENUE_TYPE
Warranty LOV_WARRANTY_TYPE
Contract LOV_CONTRACT_TYPE
For more information on the fields exposed through the opportunity Web service, go to the Web
Services Administration screen within the OnDemand application and generate the WSDL for the
opportunity object.
Portfolio
The portfolio object allows you to define and record details about the collection of financial services
that you may provide to an account. Financial services include loans, credit cards, insurance, general
banking, and so on.
NOTE: To download the Portfolio WSDL, you must be given access to the Portfolio object. If you do
not have access to the Portfolio object, it will not be available to download from the Web Services
Administration screen or available to use the vertical Web service calls. For assistance in gaining
access to the Portfolio object, contact your Siebel CRM OnDemand service provider.
Child Component
Contact
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 11 3
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Methods Called
Table 71 details the methods called by the portfolio service, and their names as defined on the
service.
Fields
Table 72 details the read-only fields for the portfolio object and its child component.
Owner Read-only
OwnerId Read-only
PrimaryContact Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
114 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
ContactFirstName Read-only
ContactLastName Read-only
ContactHomePhone Read-only
ContactEmail Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
Portfolio CreatedBy
CreatedById
CreatedDate
ExternalSystemId
PortfolioId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 11 5
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Owners ContactId
CreatedBy
CreatedById
CreatedDate
Id
ModifiedBy
ModifiedById
ModifiedDate
Table 74 details the pickmap fields for the portfolio object and its child objects.
InstitutionIntegrationId InstitutionId
InstitutionName InstitutionId
InstitutionLocation InstitutionId
Product ProductId
ProductExternalId ProductId
ProductIntegrationId ProductId
ContactIntegrationId ContactId
Table 75 provides a list of the filterable fields and user key combinations for the child components of
the portfolio object. All parent fields on the portfolio object are filterable.
Table 75. Filterable Fields and User Key Fields on the Portfolio Object’s Child Components
IntegrationId
ExternalSystemId
116 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 75. Filterable Fields and User Key Fields on the Portfolio Object’s Child Components
ContactExternalId ContactExternalId
ContactIntegrationId ContactIntegrationId
ContactFirstName
ContactLastName
ContactHomePhone
ContactEmail
PrimaryInsured
NamedInsured
PolicyOwner
Relationship
Status IMPL_PHASE
TermUnit FINS_CD_INTEREST_FREQ_MLOV
Contact Relationship CC_CLSE_ACCT_LOV_CD
For more information on the fields exposed through the portfolio Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the portfolio
object.
See Also
Contact
Product
The product object allows you to define and record details about a product or service that your
company sells to its customers, including information on product price, category, and so on. The
product object does not have any child objects.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 11 7
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Parent Services
Account, Campaign and Contact
Child Components
Activity, Contact, Lead, Product, Note and Revenue
Methods Called
Table 77 details the methods called by the product service, and their names as defined on the service.
Fields
All fields on the product object are filterable.
Table 78 details the required and read-only fields for the product object.
Table 78. Required and Read-Only Fields for the Product Object
ProductName Required
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
118 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Product Id
IntegrationId
ModifiedById
ModifiedDate
Table 80 details the pick map field for the product object.
ParentCategory ParentCategoryId
Product ProductId
IntegrationId
ExternalSystemId
Table 82 details the list of value fields available for the product object.
Table 82. List Of Values Fields Available for the Product Object
BodyStyle AUTO_BODY_STYLE_TYPE
Category PRODUCT_CATEGORY
Class PRODUCT_TYPE
DoorStyle AUTO_DOORS_STYLE_TYPE
Engine AUTO_ENGINE_TYPE
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 11 9
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 82. List Of Values Fields Available for the Product Object
Make OD_AUTO_MAKE_TYPE
Model OD_AUTO_MODEL_TYPE
PriceType UNIT_OF_MEASURE
ProductType PROD_CD
Revision FINS_PROD_STATUS_VERSION_MLOV
Status IMPL_PHASE
SubType FINS_ASSET_PROD_CLASS_MLOV
TherapeuticClass THERAPEUTIC_CLASS
Transmission AUTO_TRANSMISSION_TYPE
Trim OD_AUTO_TRIM_TYPE
For more information on the fields exposed through the product Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the product
object.
See Also
Product Category
Product Category
The product category object allows you to logically sort products into groups, where each product is
in some way related to the other products in the category. The product category object does not have
any child objects.
Methods Called
Table 83 details the methods called by the product category service, and their names as defined on
the service.
120 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Fields
All fields on the product category object are filterable.
Table 84 details the required and read-only fields for the product category object.
Table 84. Required and Read-Only Fields for the Product Category Object
CategoryName Required
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
ModifiedBy Read-only
ModifiedByFullName Read-only
ModifiedById Read-only
ModifiedDate Read-only
Table 85 details the status key for the product category object.
AdminProductLine Id
IntegrationId
ModifiedById
ModifiedDate
Name
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 12 1
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 86 details the pick map field for the product object.
Table 86. Pick Map Field for the Product Category Object
ParentCategory ParentCategoryId
Table 87 details the user keys for the product category object.
Product ProductCategoryId
IntegrationId
ExternaSystemId
Name
For more information on the fields exposed through the product category Web service, go to the Web
Services Administration screen within the OnDemand application and generate the WSDL for the
product category object.
See Also
Product
Service Request
The service request object allows customers to request information or assistance with a problem
related to products or services purchased from your company. Service requests may be ranked for
severity and prioritized accordingly.
Parent Services
Account, Contact and Solution
Child Components
Activity, Solution, Audit Trail and Note
122 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Methods Called
Table 88 details the methods called by the service request service, and their names as defined on the
service.
Fields
Table 89 details the required and read-only fields for the service request object.
Table 89. Required and Read-Only Fields for the Service Request Object
ContactEmail Read-only
ContactFirstName Read-only
ContactFullName Read-only
ContactLastName Read-only
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
LastUpdated Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
ServiceRequestConcatId Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 12 3
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 90 details the status key for the service request object.
ServiceRequest AccountId
ContactId
CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
Activity CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
124 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
ServiceRequestNote CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
ServiceRequestId
Solution CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
Table 91 details the pick map fields for the service request object.
Table 91. Pick Map Fields for the Service Request Object
Owner OwnerId
AccountExternalSystemId AccountId
AssetIntegrationId AssetId
AssetExternalSystemId AssetId
ProductExternalSystemId ProductId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 12 5
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 92 provides a list of the filterable fields for the child components of the service request object,
and a list of user key combinations for each child component. All parent fields on the service request
object are filterable.
Table 92. Filterable Fields and User Key Fields on the Service Request Object’s Child Components
IntegrationId
ExternalSystemId
SRNumber
Owner
Subject
DueDate
Priority
Status
User
FieldModified
SolutionId
Status
Id
Table 93 details the list of value fields available for the service request object.
Area SR_AREA
Cause SR_SEVERITY
Priority SR_PRIORITY
126 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Source SR_SOURCE
Status SR_STATUS
Type SR_TYPE
For more information on the fields exposed through the service request Web service, go to the Web
Services Administration screen within the OnDemand application and generate the WSDL for the
service request object.
Solution
The solution object stores information on solutions to customer problems or service requests.
Solutions can be reused if the same problem is identified with a product or service. This prevents
duplication of work for customer service representatives.
Parent Service
Service Request
Child Component
Service Request
Methods Called
Table 94 details the methods called by the solution service, and their names as defined on the
service.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 12 7
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Fields
Table 95 details the required and read-only fields for the solution object.
Table 95. Required and Read-Only Fields for the Solution Object
Title Required
CreatedBy Read-only
CreatedById Read-only
CreatedDate Read-only
CreatorId Read-only
LastUpdated Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
Solution CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
128 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
ServiceRequest CreatedBy
CreatedById
CreatedDate
ExternalSystemId
Id
IntegrationId
LastUpdated
ModifiedBy
ModifiedById
ModifiedDate
Table 97 provides a list of the filterable fields for the child components of the solution objects, and a
list of user key combinations for each child component. All parent fields on the solution object are
filterable.
Table 97. Filterable Fields and User Key Fields on the Solution Object’s Child Components
IntegrationId
ExternalSystemId
Area
Owner
Priority
Type
Cause
Source
Status
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 12 9
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 98 details the list of value fields available for the solution object.
Area SR_AREA
Cause SR_SEVERITY
Priority SR_PRIORITY
Source SR_SOURCE
Status SR_STATUS
Type SR_TYPE
For more information on the fields exposed through the solution Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the solution
object.
See Also
Service Request
Territory
The territory object allows you to store information about the sales territory that is assigned to a
user. This includes information about the territory name, a description, the currency code, and the
sales quota for the territory. The territory object does not have any associated child objects, however,
the territory object is a parent object and is defined in its own WSDL.
Methods Called
Table 99 details the methods called by the territory service, and their names as defined on the
service.
130 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Fields
All fields on the territory object are filterable. The TerritoryName field is a user key for the territory
object.
Table 100 details the required and read-only fields for the territory object.
Table 100. Required and Read-Only Fields for the Territory Object
TerritoryName Required
Territory Read-only
Table 101 details the status key for the territory object.
Territory CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
TerritoryId
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 13 1
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 102 details the pick map field for the territory object.
ParentTerritoryIntegrationId ParentTerritoryId
ParentTerritoryExternalSystemId ParentTerritoryId
ParentTerritoryId ParentTerritoryId
Table 103 details the list of value fields available for the territory object.
ParentTerritoryExternalSystemId PARENT_TERRITORY_ID
ParentTerritoryIntegrationId PARENT_TERRITORY_ID
For more information on the fields exposed through the territory Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the territory
object.
User
The user object allows you to define and record details of all users in the system—for example, name,
position, contact details, manager, and so on. It is different from the Current User object in that it is
not restricted only to the currently logged in user. It enables queries to be run on all users of the
system, and enables an administrator to insert and update a user’s profile. The user object does not
have any child components.
Parent Service
User Group
132 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Methods Called
Table 104 details the methods called by the user service, and their names as defined on the service.
Fields
All fields on the user object are filterable.
Table 105 details the required and read-only fields for the user object.
Table 105. Required and Read-Only Fields for the User Object
FirstName Required
LastName Required
CreatedById Read-only
CreatedBy Read-only
CreatedDate Read-only
LastSignInDateTime Read-only
ManagerFullName Read-only
ModifiedBy Read-only
ModifiedById Read-only
ModifiedDate Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 13 3
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 106 details the status key for the user object.
User EMailAddr
Id
IntegrationId
LastModified
LastModifiedByPersonId
Table 107 details the pick map field for the user object.
Role RoleId
Table 108 provides a list of user key combinations for the user object.
ExternalSystemId
IntegrationId
EmailAddr
For more information on the fields exposed through the user Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the user object.
See Also
Current User
134 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
User Group
The User Group object allows you to create groups to which users can be added. Users can only be
a member of one group, and groups can contain many users.
Child Component
User
Methods Called
Table 109 details the methods called by the user group service, and their names as defined on the
service.
Fields
Table 110 details the required and read-only fields for the user group object.
Table 110. Required and Read-Only Fields for the User Group Object
UserGroupId Read-only
UserId Read-only
Alias Read-only
Email Read-only
Role Read-only
UserFirstName Read-only
UserLastName Read-only
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 13 5
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 111 details the status key for the user group object.
UserGroup CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
UserGroupId
UserGroupIntegrationId
UserGroupExternalSystemId
User CreatedBy
CreatedById
CreatedDate
Members_UserId
ModifiedBy
ModifiedById
ModifiedDate
UserExternalSystemId
UserIntegrationId
Table 112 details the pick map field for the user group object.
Table 112. Pick Map Field for the User Group Object
UserExternalSystemId UserId
136 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 113 provides a list of the filterable fields for the child components of the user group object, and
a list of user key combinations for each child component. All parent fields on the user group object
are filterable.
Table 113. Filterable Fields and User Key Fields on the Solution Object’s Child Components
User UserGroupId
UserId
UserIntegrationId
UserExternalSystemId
Alias
Role
UserFirstName
UserLastName
For more information on the fields exposed through the user group Web service, go to the Web
Services Administration screen within the OnDemand application and generate the WSDL for the user
group object.
Vehicle
The vehicle object allows you to create and store information about a vehicle, for example, a car, a
truck, a van, and so on, that your company would like to sell to a contact or account. This information
includes the vehicle’s current mileage, the invoice price, the dealership, the make, and so on.
NOTE: To download the Vehicle WSDL, you must be given access to the Vehicle object. If you do not
have access to the Vehicle object, it will not be available to download from the Web Services
Administration screen or available to use the vertical Web service calls. For assistance in gaining
access to the Vehicle object, contact your Siebel CRM OnDemand service provider.
Child Component
Contact
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 13 7
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Methods Called
Table 114 details the methods called by the vehicle service, and their names as defined on the
service.
Fields
Table 115 details the required and read-only fields for the vehicle object.
Table 115. Required and Read-Only Fields for the Vehicle Object
Contact Read-only
ProductType Read-only
SellingDealer Read-only
ServicingDealer Read-only
Contact ContactId Required
ContactExternalSystemId Required
ContactIntegrationId Required
138 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 116 details the status key for the vehicle object.
Vehicle CreatedBy
CreatedById
CreatedDate
ExternalSystemId
IntegrationId
ModifiedBy
ModifiedById
ModifiedDate
VehicleId
Contact ContactId
CreatedBy
CreatedById
CreatedDate
ModifiedBy
ModifiedById
ModifiedDate
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 13 9
OnDemand Objects Exposed Through Web Services ■ Parent Objects
Table 117 details the pick map fields for the vehicle object.
AccountSite AccountId
AccountIntegrationId AccountId
AccountExternalID AccountId
SellingDealerExternalId SellingDealerId
SellingDealerIntegrationId SellingDealerId
ServicingDealerExternalId ServicingDealerId
ServicingDealerIntegrationId ServicingDealerId
ContactIntegrationId ContactId
Table 118 provides a list of the filterable fields for the child components of the vehicle object, and a
list of user key combinations for each child component. All parent fields on the vehicle object are
filterable.
Table 118. Filterable Fields and User Key Fields on the Vehicle Object’s Child Components
ContactExternalSystemId ContactExternalSystemId
ContactIntegrationId ContactIntegrationId
ContactFirstName
140 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Child Objects
Table 119 details the list of value fields available for the vehicle object.
Body AUTO_BODY_STYLE_TYPE
Door AUTO_DOORS_STYLE_TYPE
Engine AUTO_ENGINE_TYPE
ExteriorColor AUTO_EXTERIOR
InteriorColor AUTO_INTERIOR
Location AUTO_VEHICLE_LOC
Make OD_AUTO_MAKE_TYPE
Model OD_AUTO_MODEL_TYPE
VehicleOwnedBy AUTO_OWNED_BY
Status IMPL_PHASE
Transmission AUTO_TRANSMISSION_TYPE
Trim OD_AUTO_TRIM_TYPE
UsedNew AUTO_NEW_USED_TYPE
WarrantyType WARR_TYPE
Year YEAR
For more information on the fields exposed through the vehicle Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the vehicle
object.
Child Objects
The following is a list of the child objects that are used in Siebel OnDemand Web Services:
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 14 1
OnDemand Objects Exposed Through Web Services ■ Child Objects
Address
The address object stores information on the different addresses that are associated with accounts
and contacts. It is used to store billing and shipping addresses for accounts. It is also used to store
personal addresses for contacts.
Parent Object
Account
Asset
The asset object stores information on the assets held by your accounts—for example, the products
that an account has purchased. The asset object is used to manage products through their life cycle.
It is also used by your accounts to register products, receive product news and literature, track
warranty agreements, and receive recommendations on scheduled services.
Fields
Table 120 details the list of value fields available for the asset object.
Type PRODUCT_TYPE
For more information on the fields exposed through the user Web service, go to the Web Services
Administration screen within the OnDemand application and generate the WSDL for the asset object.
Parent Object
Account
142 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Child Objects
Audit Trail
The audit trail object stores information about how a service request object is modified from the
moment that it created until a solution for the service request has been found. The audit trail object
stores information such as the created and modified dates for the service request, and also the users
that created and updated the service request.
Parent Object
Service Request
Competitor
The competitor object in the Account interface exposes the information on competitors for your
accounts.
Fields
Table 121 details the list of value fields available for the competitor object.
RelationshipRole PARTY_REL_TYPE
ReverseRelationshipRole PARTY_REL_TYPE
For more information on the competitor fields exposed, go to the Web Services Administration screen
within the OnDemand application and generate the WSDL file.
Parent Object
Account
Login History
The login history object stores information about currently logged in user such as the amount of
times that the user has logged in, and the dates and times on which the current user logged in.
Parent Object
Current User
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 14 3
OnDemand Objects Exposed Through Web Services ■ Child Objects
Parent Objects
Account
Note
The note object stores extra information (as a note) on a parent object. This allows employees who
are working on a particular record to add extra information as they see fit. For example, when talking
to a contact, an employee may notice that the contact is not happy with a service provided. The
employee may record this in a note so that any other employees who talk to the contact are aware
of the contact’s dissatisfaction.
Parent Objects
Account, Campaign, Contact, Opportunity and Service Request
Partner
The partner object in the Account interface exposes the information on partners for your accounts.
Fields
Table 122 details the list of value fields available for the partner object.
RelationshipRole PARTY_REL_TYPE
ReverseRelationshipRole PARTY_REL_TYPE
For more information on the partner fields exposed, go to the Web Services Administration screen
within the OnDemand application and generate the WSDL file.
Parent Object
Account
144 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand Objects Exposed Through Web Services ■ Child Objects
Quota
The quota object stores information about the sales targets of, and sales made by the current user.
Parent Object
Current User
Related Account
The related account object stores information on an account that has a relationship with the parent
account in question. The details of the related account child object are inherited from a particular
account parent object.
Parent Object
Account
Related Contact
The related contact object stores information on an contact that has a relationship with the parent
contact in question. The details of the related contact child object are inherited from a particular
contact parent object.
Parent Object
Contact
Revenue
The revenue object stores monetary information about accounts, contacts and their associated
opportunities. This includes information on the revenue available, expected revenue, and also
information about the products associated with the accounts, contacts and opportunities, and so on.
Parent Object
Account, Contact and Opportunity
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 14 5
OnDemand Objects Exposed Through Web Services ■ Child Objects
Team
The team object stores information on the team that is assigned to a particular account or contact.
In this way, a team of employees can be dedicated to an account or contact, ensuring that the
activities, service requests, leads, and opportunities surrounding that account or contact are always
kept up-to-date and are attended to regularly.
Parent Object
Account and Contact
146 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
5 Web Services OnDemand API
Calls
There are a number of methods that can be invoked by the OnDemand objects. For each object, the
methods are defined in the WSDL for that object. Many of the methods described in this chapter can
call all of the objects.
The methods invoked by the OnDemand objects are used to insert, update, and find data within a
specified OnDemand instance. The following sections detail the methods that may be called on the
OnDemand objects. For each of these methods, the description, usage, arguments taken, and return
values are detailed.
■ “API Calls”
API Calls
The OnDemand Web Services’ core methods are listed in Table 123. The core methods consist of
those methods that may be called on the OnDemand objects — for example, Account, Contact,
Opportunity, and so on.
Delete Uses input XML objects to find records in the Siebel OnDemand database
that match specified field values, and then deletes them (in other words,
puts them into the Recycle Bin).
InsertOrUpdate Updates an existing record or inserts a new record if one did not exist for
this instance of the object.
QueryPage Executes a query against a specified list of records, and returns a subset
of the records that match the search criteria set by the method
arguments.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 14 7
Web Services OnDemand API Calls ■ API Calls
Delete
Removes the record of the specified object from the OnDemand database.
Usage
You use the delete method to remove one or more records of a particular object from an OnDemand
instance.
Table 124 illustrates the behavior of the delete method on child objects related to the parent object
being deleted. For details on deleting a specific child from a parent level object, see “Update” on
page 156.
Asset None
Competitor None
Contact None
Lead Delete
Note Delete
Opportunity Delete
Partner None
ServiceRequest None
Team None
Campaign Activity Delete
Contact None
Lead Delete
Note Delete
Opportunity Delete
Lead Delete
Note Delete
Opportunity None
ServiceRequest None
148 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Web Services OnDemand API Calls ■ API Calls
Contact None
Lead Delete
Note Delete
AuditTrail None
Note None
Arguments
Table 125 documents the arguments taken by the delete method.
See Also
Update.
Insert
Inserts a new record in the OnDemand database.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 14 9
Web Services OnDemand API Calls ■ API Calls
Usage
You use the insert object to create one or more records of a particular object from an OnDemand
instance. Each of the objects (both child and parent level) provided in the input argument must
provide data in at least one of the user keys for the given object. The user key information is used
to uniquely identify records. If no user key values are provided, or if there is a conflict with the user
keys of an existing record, the insert method will fail, and a SOAP error will be thrown by the API.
When inserting a batch of records, the batch is treated as a single transaction. If one record fails to
insert during a batch insertion, the entire operation is rolled back and no records are inserted.
Arguments
Table 126 documents the arguments taken by the insert method.
See Also
Update.
InsertOrUpdate
Updates an existing record or inserts a new record if one did not exist for this instance of the object.
Usage
You use the InsertOrUpdate method to update one or more records of a particular object in an
OnDemand instance. Each of the objects (both child and parent level) provided in the input argument
must provide data in at least one of the user keys for the given object. Use the user key information
to uniquely identify records. If no user key values are provided or if there is a conflict with the user
keys of an existing record, the insert method fails, and a SOAP error is thrown by the API.
Use the user key specified for the parent level objects in the input argument to determine whether
to insert each of the parent records, or to update an existing parent record.
150 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Web Services OnDemand API Calls ■ API Calls
Table 127 outlines how the delete method acts upon parent and child objects to create or update an
object instance.
Arguments
Table 128 documents the arguments taken by the InsertOrUpdate method.
ListOf(Object). For The object instance to be inserted Yes Not available I/O
example, ListOfAccount or updated.
See Also
Update
Insert
QueryPage
Executes a query against a specified list of records, and returns a subset of the records that match
the search criteria set by the method arguments. You can use the QueryPage method in a number
of different ways to return records, which means that there are a number of functions that can be
performed using this method. For example, it is possible to query by example, by template, or by
children. For more information, see “Querying OnDemand Data Using Web Services” on page 153 and
Appendix A, “OnDemand XML API Samples.”
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 15 1
Web Services OnDemand API Calls ■ API Calls
Usage
This method is useful when the search specification retrieves a large number of records at the root
component. To avoid returning one huge set of results, you can specify the number of records to be
returned using the PageSize argument. You can also use the StartRowNum method argument to
dictate which records are to be returned.
Even though the QueryPage method returns a limited number of records, it keeps the data in the
cache, which you can then retrieve by calling the QueryPage method again with a new value for the
StartRowNum method argument.
For all OnDemand object methods, it is possible to query, update, or insert using one operation within
a parent-child relationship. This type of query is called QueryByChildren. The query can be
assembled using parent attributes as well as child attributes. You can query for all children of a
particular parent or set of parents, all parents of a particular child or set of children, or for both
parents and children of a particular set. The QueryByChildren method uses the same expression
notation as QueryByExample, where the expression may appear in either the parent, the child, or
both. These queries are described in Appendix A, “OnDemand XML API Samples.”
NOTE: If you want to include a field to be returned in a query’s results, you must include a blank tag
in the QueryPage input. Effectively, this means that you must set the field’s value to “”, that is, an
empty string.
conjunction OR
conjunction AND
expression IS NULL
expression operator value
literalChar ''
operator =
operator ~=
operator <
152 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Web Services OnDemand API Calls ■ API Calls
operator <=
operator >
operator >=
operator <>
operator LIKE
operator ~LIKE
value 'literal'
■ If you want to use a single quote within a literal, you must place another single quote
immediately beside the quote that you want to specify as a literal. In this way, the query
recognizes the quote as a literal and not as an operator. For example, the string ab'c is presented
as ab''c.
■ In order to use the wildcard characters asterisk (*), question mark (?), and backslash (\) in
queries, they must be preceded by the backslash (\) character. For example, if you want to use
the ? wildcard operator in a query, you must precede it with the backslash character as follows:
\?
■ Every expression must start with an operator to avoid ambiguity. There is no default operator.
■ Wildcard characters are treated as such only in the context of the operator LIKE.
■ To find a match for a value that has no value, the IS NULL expression must be specified as the
QBE field's value.
■ The tilde (~) and equal (=) ~= operator denotes a case-insensitive exact search (no wildcards
used), while the ~LIKE operator denotes a case-insensitive wildcard search.
To query an object by a certain field, specify the Query by Example expression that corresponds to
the desired result. For information about Query by Example expression samples, see Table 137.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 15 3
Web Services OnDemand API Calls ■ API Calls
<ListOfContact>
<Contact>
<JobTitle>= ‘CEO’</JobTitle>
<ContactLastName>='Doe'</ContactLastName>
<ContactFirstName />
</Contact>
</ListOfContact>
NOTE: For multiple Query by Example expressions on a single field, each Query by Example
expression must be enclosed in brackets.
Send the following XML representation of the ListOfContact object in the ContactQueryPage call:
<ListOfContact>
<Contact>
<JobTitle />
<ContactLastName />
<ContactFirstName />
154 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Web Services OnDemand API Calls ■ API Calls
</Contact>
</ListOfContact>
Send the following XML representation of the ListOfContact object in the ContactQueryPage call:
<ListOfContact>
<Contact>
<JobTitle />
<ContactLastName>(='Doe') OR (=’Brown’)</ContactLastName>
<ContactFirstName />
</Contact>
</ListOfContact>
Arguments
Table 130 documents the arguments taken by the QueryPage method.
ListOf(Object). The list of object instances queried (input), Yes Not I/O
For example, and after query execution, the list of object applicable
ListOfAccount instances returned (output).
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 15 5
Web Services OnDemand API Calls ■ API Calls
LastPage: A Boolean value that indicates whether or not the last value in the query set has been
returned.
Update
Updates the selected record with the new value.
Usage
You use the update method to update one or more records of a particular object in an OnDemand
instance. Each of the objects (both child and parent level) provided in the input argument must
provide data in at least one of the user keys for the given object. You use the user key information
to uniquely identify records. If no user key values are provided, or if there is a conflict with the user
keys of an existing record, the insert method will fail, and a SOAP error is thrown by the API.
156 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Web Services OnDemand API Calls ■ Service API Calls
Table 131 outlines how the update method acts upon parent and child objects to update an object
instance.
Arguments
Table 132 documents the arguments taken by the update method.
“GetListOfValues” on Gets a lists of values from external applications and presents them to
page 158 OnDemand end users.
“GetMapping” on Gets a list of the display names of fields for a particular service and their
page 159 associated XML tags.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 15 7
Web Services OnDemand API Calls ■ Service API Calls
GetListOfValues
Gets a list of values from external applications and presents them to OnDemand end users.
Usage
This method is used to enable external applications to present lists of values to end users, typically
in a language-dependent manner.
The returned list of values corresponds to the organization to which the current end user (that is,
the user whose credentials have been passed during the log-in call) belongs.
NOTE: You can use this method for getting the list of values allowed for customized picklist fields—
for example, in querying LOV type OCC_CUST_LOV_ACCOUNT_0 to get a list of values for the field
with XML tag CustomPickList0 in the Account Web Service.
For examples of LOV Service elements, see “LOV Service Element Sample” on page 170.
Arguments
Table 134 documents the arguments taken by the GetListOfValues method.
■ Language
■ Type
158 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Web Services OnDemand API Calls ■ Service API Calls
GetMapping
Returns the display names and XML tags of the fields of a named Web service or one of its child
components.
Usage
This method is used to return the display names of all the fields in a particular Web service. It also
returns the XML tags for each field. It, therefore, displays the mappings between the display names
of fields and their XML tags.
This method can be used on all Web services and on all of their child components.
Arguments
Table 135 documents the arguments taken by the GetListOfValues method.
SetPasswordAPI
Allows the system administrator to set the passwords of users that use the application.
Usage
This method is used to enable external applications to synchronize user passwords. For security
reasons the password API is not available by default. If a customer wishes to use SetPasswordAPI,
they can call Customer Care to have the functionality enabled.
The API allows for the setting of passwords for one or more users at the same time. For each
password that is updated, a corresponding user Audit Trail record is created. A user with the ability
to set passwords does not have the ability to update the password of another user that has the ability
to set passwords.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 15 9
Web Services OnDemand API Calls ■ Service API Calls
UserId Read-only
UserExternalId Read-only
UserIntegrationID Read-only
UserEmail Read-only
Password Create/Read/Update/Delete
160 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
A OnDemand XML API Samples
This appendix displays samples of XML code generated by OnDemand, and it contains the following
sections:
abc
abcd
'abc'
= 'abc'
abc?d
abc*d
aBc*D
abcd
abc*d
abc\d
abc\*d
abc\\*d
abc\d
abc\*'d
abc\?"d
abc\*"d
abc\*'"d
(NULL value)
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 16 1
OnDemand XML API Samples ■ Query by Example Expression Samples
Table 137 specifies the returned record sets for various values of each Query by Example field value
that maps to the preceding list.
= '''abc ''''abc'
= 'abc 'abc
= 'abc?d 'abc?d
= 'abc\?d 'abc?d
= 'abc\*d 'abc*d
= 'abc\\*d 'abc\*d
162 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand XML API Samples ■ Query by Example Expression Samples
= 'abc\\?"d 'abc\?"d
= 'abc\\\?"d 'abc\*"d
= 'abc\\\*''d 'abc\*'d
> 'abc' BUT < 'abcd' N/A BUT is not a valid conjunction. Consequently,
this query returns an error.
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 16 3
OnDemand XML API Samples ■ Query by Template Samples
<ListOfAccount>
<Account>
<Name />
<Location>IS NULL</Location>
</Account
</ListOfAccount>
The search specification that the system applies to the Account BusComp is as
follows:
<ListOfAccount>
<Account>
<LastUpdated>10/14/2003 04:25:32</LastUpdated>
<Name>IBM</Name>
<Location></Location>
</Account>
<Account>
<Name>Siebel</Name>
<Location></Location>
</Account>
</ListOfAccount>
164 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand XML API Samples ■ Query by Children Samples
<ListOfAccount>
<Account>
<LastUpdated/>
<Name>LIKE 'Sie*'<Name/>
</Account>
</ListOfAccount>
<ListOfAccount>
<Account>
<Location>San Mateo</Location>
</Account>
<Account>
<Name>Siemens</Name>
<Location>San Mateo</Location>
</Account>
</ListOfAccount>
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 16 5
OnDemand XML API Samples ■ Query by Children Samples
<ListOfAccount>
<Account>
<Name></Name>
<Location></Location>
<ListOfContact>
<Contact>
FirstName><FirstName>
<LastName></Lastname>
</Contact>
</ListOfContact>
<ListOfBusinessAddress>
<BusinessAddress>
<Address/>
<City/><State/>
<ZipCode/>
<BusinessAddress>
</ListOfBusinessAddress>
</Account>
</ListOfAccount>
Using a formal search specification language, the system interprets this query as follows:
AND
166 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand XML API Samples ■ Query by Children Samples
OR
EXISTS
AND
OR
EXISTS
AND
This tells the system to find all accounts that have met one of the following conditions between 05/
12/02 10:00:03 PM and 05/18/02 10:02:22 PM in the current user's time zone that have:
■ Been updated
<ListOfOpportunity>
<Opportunity>
<Description/>
<Revenue></Revenue>
<ListOfContact>
<Contact>
<FirstName></FirstName>
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 16 7
OnDemand XML API Samples ■ Query by Children Samples
<LastName></Lastname>
</Contact>
</ListOfContact>
</Opportunity>
</ListOfOpportunity>
Using a formal search specification language, the system interprets this query as follows:
This tells the system to find all opportunities that are associated either with a contact whose Id is
12-12345, or with a contact whose Id is 12-54321.
<ListOfAccount>
<Account>
<Name></Name>
<Location></Location>
<ListOfContact>
<Contact>
<FirstName>= 'Sanjin'<FirstName>
<LastName>= 'Tulac'</Lastname>
<MiddleName />
</Contact>
<Contact>
<FirstName>LIKE 'Alex*'<FirstName>
<LastName>LIKE 'Warsha*'</Lastname>
</Contact>
</ListOfContact>
<ListOfOpportunity>
<Opportunity>
168 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
OnDemand XML API Samples ■ Query by Children Samples
<Description/>
<Revenue>>= '10000'</Revenue>
</Opportunity>
</ListOfOpportunity>
</Account>
</ListOfAccount>
The system interprets this input to the QueryPage method as the following search specification:
OR
EXISTS
OR
OR
EXISTS
This tells the system to find all accounts that meet one of the following conditions:
■ Have been updated since 05/12/02 10:00:03 PM in current user's time zone
■ Are associated with a contact whose first name is Sanjin and whose last name is Tulac
■ Are associated with a contact whose first name starts with Alex and whose last name starts with
Warsha
■ Have an associated opportunity whose revenue is estimated at more than 10000 units of
currency
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 16 9
OnDemand XML API Samples ■ LOV Service Element Sample
<ListOfLOV>
<LOV>
<Language>ENU</Language>
<LIC>Competitor</LIC>
<Type>ACCOUNT_TYPE</Type>
<LDV>Competitor</LDV>
</LOV>
<LOV>
<Language>ENU</Language>
<LIC>Customer</LIC>
<Type>ACCOUNT_TYPE</Type>
<LDV>Customer</LDV>
</LOV>
<LOV>
<Language>ENU</Language>
<LIC>Partner</LIC>
<Type>ACCOUNT_TYPE</Type>
<LDV>Partner</LDV>
</LOV>
</ListOfLOV>
170 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Index
A C
access C# code sample 30
locale-dependent access 18 campaign object
Account interface about 54
competitor object 143 child components 55
partner object 144 fields 55
account object filterable fields 58
about 34 list of values 60
child components 34 methods 55
fields 35 parents 55
fields, do not use 48 pick map field 58
filterable fields 41 read-only fields 55
methods 34 required fields 55
pick map fields 40 status key 56
picklists 47 child components
read-only fields 35 account 34
required fields 35 activity 49
status key 36 campaign 55
activity object contact 60, 98
about 48 current user 73
child components 49 CustomObject1 75
fields 49 CustomObject2 83
filterable fields 53 household 93
list of values 54 opportunity 104, 118
methods 49 portfolio 113
parents 49 service request 122
pick map fields 52 solution 127
read-only fields 49 user group 135
required fields 49 vehicle 137
status key 50 child objects
usage 48 asset 142
user key fields 53 audit trail 143
API calls competitor 143
core methods 147 login history 143
Delete method 148 multiple contact roles 144
GetListOfValues 158 note 144
GetMapping 159 partner 144
Insert method 149 quota 145
InsertOrUpdate method 150 related account 145
QueryPage method 151 related contact 145
Service API calls 157 revenue 145
SetPasswordAPI 159 team 146
Update method 156 client integrations
asset child object 142 examples 10
audit fields 17 code samples
audit trail object 143 C# code sample 30
Java code sample 26
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 17 1
Index ■ D
172 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Index ■ G
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 17 3
Index ■ M
M methods 15
methods parent and child relationships, about 14
OnDemand objects, called by 15 pick maps 16
parent and child objects, behavior of 15 status keys 16
methods called by user keys 15
account 34 XML API Reliability 12
activity 49 XML API Security 11
campaign 55 opportunity object
contact 61 about 104
current user 73 child components 104, 118
CustomObject1 75 fields 105
CustomObject2 83 filterable fields 110
dealer 91 list of value fields 113
household 94 methods 105
lead 98 parents 104
LOV 104 pick map field 109
opportunity 105 read-only fields 105
portfolio 114 required fields 105
product 118 status key 107
product category 120
service request 123 P
solution 127 parent and child objects
territory 130 about and list of 12
user 133 InsertOrUpdate method, effect on 151
user group 135 methods, behavior of 15
vehicle 138 relationships, about 14
multiple contact roles child object 144 Update method, effect of 157
parent objects
N account 34
new features 7 activity 48
note child object 144 campaign object 54
Number and Currency fields 18 contact object 60
current user 73
dealer 91
O household object 93
objects lead 98
OnDemand objects, methods called by 15 list of 33
OnDemand parent and child objects 12 LOV 102
parent and child objects, behavior of opportunity 104
methods 15 portfolio 113
parent and child relationships, about 14 product 117
pick maps 16 product category 120
status keys 16 service request 122
user keys 15 solution 127
objects, exposed territory 130
See parent objects; child objects user 132
OnDemand user group 135
custom fields 17 vehicle 137
integration tag 17 parent services
OnDemand Web Services 10 activity 49
communication with (figure) 9 campaign 55
OnDemand objects, methods called by 15 contact 60
OnDemand parent and child objects 12 lead 98
parent and child objects, behavior of
174 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Index ■ Q
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 17 5
Index ■ S
176 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)
Index ■ V
Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10) 17 7
Index ■ X
178 Siebel Web Services OnDemand Guide Version 5 (CRM OnDemand Release 10)