0% found this document useful (0 votes)
209 views264 pages

Taleo Business Edition: API Guide

TaleoWebAPI

Uploaded by

Bhavani
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
209 views264 pages

Taleo Business Edition: API Guide

TaleoWebAPI

Uploaded by

Bhavani
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 264

API Guide

Taleo Business Edition


September 2009
Candidate API Calls
getCandidateById Element:

Copyright Noti ce
CONFIDENTIAL INFORMATION OF TALEO.
UNAUTHORIZED USE IS STRICTLY PROHIBITED.
Taleo is a trademark of Taleo Inc.
© Taleo. All rights reserved.
These Release Notes are protected by copyright and other intellectual property law and is subject to the
confidentiality and other restrictions specified in the Agreement.

Taleo
4140 Dublin Boulevard, Suite 400
Dublin, CA 94568
United States
Tel.: 925.452.3000
Fax: 925.452.3001
www.taleo.com

Taleo Business Edition API Guide Page 2


Candidate API Calls
getCandidateById Element:

Contents
COPYRIGHT NOTICE...................................................................................................................2

WELCOME..................................................................................................................................8

Audience and Background...............................................................................................8


Required Knowledge and Skills........................................................................................8
Support............................................................................................................................9

INTRODUCTION.........................................................................................................................9

Security and User Authentication....................................................................................9


Obtaining the Taleo Business Edition WSDLs................................................................10
Importing the WSDLs to Your Development Platform...................................................10
Getting Started...............................................................................................................10
Error Tracing...................................................................................................................11

API SIMPLE DATA OBJECTS (BEANS)..........................................................................................11

Important Notes on Data Transfer:................................................................................12


Required Fields..............................................................................................................12
XML Data Types..............................................................................................................13

ACCOUNT API CALLS................................................................................................................13

createAccount Element:................................................................................................14
deleteAccount Element:................................................................................................16
getAccountById Element:..............................................................................................17
getAccountHistory Element:..........................................................................................18
searchAccount Element:................................................................................................20
updateAccount Element:...............................................................................................23

ATTACHMENT API CALLS..........................................................................................................25

createAttachment Element:...........................................................................................25
createEntityAttachment Element:.................................................................................27
deleteAttachment Element:...........................................................................................28
getAttachment Element:................................................................................................29

Taleo Business Edition API Guide Page 3


Candidate API Calls
getCandidateById Element:

getAttachmentData Element:........................................................................................31
getAttachments Element:..............................................................................................32
getEntityAttachments Element:.....................................................................................33
updateAttachment Element:.........................................................................................34

BACKGROUND CHECK API CALLS..............................................................................................36

createBackgroundCheck Element:.................................................................................37
deleteBackgroundCheck Element:.................................................................................38
getBackgroundCheckById Element:...............................................................................39
getBackgroundChecksByCandidate Element:................................................................41
updateBackgroundCheck Element:...............................................................................42

CANDIDATE API CALLS..............................................................................................................44

createCandidate Element:.............................................................................................47
deleteCandidate Element:.............................................................................................49
getCandidateById Element:...........................................................................................50
getCandidateDetailsById Element:................................................................................53
getCandidateHistory Element:.......................................................................................57
getCandidatesByRequisition Element:...........................................................................58
getCandidateWorkHistory Element:..............................................................................60
getCandReqStatus Element:..........................................................................................62
searchCandidate Element:.............................................................................................65
submitCandidate Element:............................................................................................68
removeCandidate Element:...........................................................................................69
updateCandidate Element:............................................................................................71
upsertCandidateToRequisitions Element:......................................................................73

CANDIDATE ROLLING ENTITY CALLS.........................................................................................76

deleteRollingEntity Element:.........................................................................................77
getRollingEntities Element:............................................................................................78
upsertRollingEntity Element:.........................................................................................83

CONTACT API CALLS.................................................................................................................84

createContact Element:.................................................................................................86
deleteContact Element:.................................................................................................88
getContactById Element:...............................................................................................89
updateContact Element:................................................................................................95

Taleo Business Edition API Guide Page 4


Candidate API Calls
getCandidateById Element:

CONTACT LOG API CALLS..........................................................................................................97

createContactLog Element:...........................................................................................97
deleteContactLog Element:...........................................................................................99
getContactLogById Element:.......................................................................................100
getContactLogsByEntity Element:................................................................................101
updateContactLog Element:........................................................................................103

EMAIL LOG API CALLS.............................................................................................................104

createEmailLog Element:.............................................................................................104
createEmailSentLog Element:......................................................................................106

EMPLOYEE API CALLS.............................................................................................................107

createEmployee Element:............................................................................................110
deleteEmployee Element:............................................................................................113
deleteEmployeeByNumber Element:..........................................................................114
getEmployeeById Element:..........................................................................................115
getEmployeeByNumber Element:...............................................................................117
searchEmployee Element:...........................................................................................119
updateEmployee Element:..........................................................................................122
upsertEmployee Element:...........................................................................................125

EVENT API CALLS....................................................................................................................128

createEvent Element:...................................................................................................130
deleteEvent Element:...................................................................................................132
getEventByEntity Element:..........................................................................................133
getEventById Element:.................................................................................................134
getPublicEvents Element:............................................................................................136
updateEvent Element:.................................................................................................137

INTERVIEW API CALLS............................................................................................................139

createInterview Element:............................................................................................140
deleteInterview Element:............................................................................................142
getInterviewsByCandidate Element:...........................................................................143
getInterviewById Element:..........................................................................................144
updateInterview Element:...........................................................................................146

LINK API CALLS.......................................................................................................................148

Taleo Business Edition API Guide Page 5


Candidate API Calls
getCandidateById Element:

createLink Element:.....................................................................................................148
removeLink Element:...................................................................................................150

LOGIN API CALLS....................................................................................................................151

getUrl Element.............................................................................................................151
login Element:..............................................................................................................152
logout Element:...........................................................................................................153
getLoginToken Element:...............................................................................................154

METADATA / PICKLIST API CALLS............................................................................................155

getLookup Element:.....................................................................................................156
getMetadata Element:.................................................................................................158

OFFER API CALLS....................................................................................................................160

createOffer Element:...................................................................................................161
deleteOffer Element:...................................................................................................163
getBinaryOffer Element:..............................................................................................164
getOfferByID................................................................................................................165
getOffers Element:.......................................................................................................166
setBinaryOffer..............................................................................................................168
updateOffer Element:..................................................................................................169

REFERENCE API CALLS............................................................................................................171

createReference Element:...........................................................................................172
deleteReference Element:...........................................................................................173
getReferencesByCandidate Element:..........................................................................174
getReferenceById Element:.........................................................................................176
updateReference Element:..........................................................................................177

REQUISITION API CALLS.........................................................................................................180

createRequisition Element:..........................................................................................181
createRequisitionTemplate Element:...........................................................................182
deleteRequisition Element:.........................................................................................184
getRequisitionById Element:.......................................................................................185
getRequisitionHistory Element:...................................................................................188
getRequisitions Element:...............................................................................................63
postRequisition Element:.............................................................................................190

Taleo Business Edition API Guide Page 6


Candidate API Calls
getCandidateById Element:

searchRequisition Element:.........................................................................................192
unpostRequisition Element:........................................................................................195
updateRequisition Element:........................................................................................197

RESUME API CALLS.................................................................................................................199

getBinaryResume Element:.........................................................................................199
parseResume Element:................................................................................................200
parseResumeIntoCandidate Element:.........................................................................202
setBinaryResume Element:..........................................................................................203

SEARCH API CALLS..................................................................................................................205

System-Wide Search Definition:..................................................................................205

SYSTEM API CALLS..................................................................................................................207

getEnabledServices Element:......................................................................................207
getSystemProps Element:............................................................................................208

TASK API CALLS......................................................................................................................211

createTask Element:.....................................................................................................213
deleteTask Element:.....................................................................................................215
getTaskByEntity Element:............................................................................................216
getTaskById Element:...................................................................................................217
getTaskByUser Element:..............................................................................................219
updateTask Element:...................................................................................................220

USER API CALLS......................................................................................................................222

createUser Element:....................................................................................................226
createUserWithPermissions Element:.........................................................................227
deleteUser Element:....................................................................................................230
getUserById Element:..................................................................................................231
getUserHistory Element:..............................................................................................232
searchUser Element:....................................................................................................234
updateUser Element:...................................................................................................237

USER ASSOCIATION CALLS......................................................................................................239

getAssociatedUsers Element:......................................................................................239
removeAssociatedUser Element:.................................................................................240

Taleo Business Edition API Guide Page 7


Candidate API Calls
getCandidateById Element:

setAssociatedUser Element:........................................................................................242

Taleo Business Edition API Guide Page 8


Candidate API Calls
getCandidateById Element:

Welcome

Audience and Background

This guide is intended for developers who plan to utilize the Taleo Business Edition
platform API for integration with third-party products and services.

The Taleo Business Edition SOAP API provides programmatic access to the Taleo Business
Edition application. The API provides the same functions and capabilities as a logged in
user of the system would have access to. Developers are able to build custom
applications and services in their platform of choice that supports the open standard
“Web Services” methodology via the utilization of:
 Simple Object Access Protocol (SOAP) calls
 Taleo defined Web Services Definition Language (WSDL), and
 XML Schema Definition language (XSD)

All areas are defined within this document.

Required Knowledge and Skills

Use of this guide assumes you are already familiar with the following:
 Taleo Business Edition (click Knowledgebase & Help sections from your instance)
 HTML (details at http://www.w3schools.com/html/default.asp)
 XML and XHTML (details at http://www.w3schools.com/xml/default.asp)
 Web Services (details at http://www.w3schools.com/webservices/default.asp)
 SOAP (details at: http://www.w3schools.com/soap/default.asp)

A SOAP client can be written in a wide range of development tools and platforms, such as Java,
Visual Basic, Perl, C#, PHP, .NET, etc. As such, Taleo does not provide platform code support or
sample code to developers. The API is inherent to the application, not a supported module, and
Taleo assumes that developers are experts in their platform of choice with utilizing web services.

A sample client-side API Toolkit using the IBM Apache Foundation Axis implementation is
available for reference at http://www.taleo.com/solutions/business-edition-integration-web-
api.php if valued. Additional documentation and details on IBM Apache Foundation Axis is
available at: http://ws.apache.org/axis/. Please note that the API Toolkit requires JDK 1.4 or
above, which can be downloaded from http://java.sun.com.

Taleo Business Edition API Guide Page 9


Candidate API Calls
getCandidateById Element:

Simple SOAP-based sample test cases have been provided within the API Guide to provide
assistance and direction in making Taleo Business Edition API calls.

Support

Contact Taleo Business Edition Support for any technical issues as they pertain to the API at
[email protected].

Introduction
The Taleo Business Edition Web API provides for simple integration between Taleo and other
systems by means of SOAP-based web services procedure calls. The API uses SOAP over HTTPS to
receive requests and send responses, allowing seamless integration between Taleo and other
enterprise applications regardless of the programming language used by the client.

Security and User Authentication

Only Taleo Premium Service customers can access the Taleo Web API. If you are a trial customer,
or current Taleo subscriber interested in evaluating the Web API, please contact your sales
representative to request Premium Service for access.

Taleo Business Edition API exposes all SOAP methods using SSL, however an SSL certificate is not
required by the client application.

Client applications must make a login call to the Taleo Web API providing valid credentials of an
existing defined user within the Taleo Business Edition user interface. Either a new user will need
to be created within the application, or an existing user can be utilized. Client applications that
access the Taleo Business Edition API are subjected to the same Access Control restrictions as
defined within the application; please validate what controls you will need the API to use and
define a user with the appropriate controls accordingly.

Credentials needed to log in to the API include (in login call order):
 Company Code
 User Name
 Password

Taleo Business Edition API Guide Page 10


Candidate API Calls
getCandidateById Element:

If login is successful, the call will return a session ID to be used in all subsequent calls to the API
as the very first parameter.

Obtaining the Taleo Business Edition WSDLs

As with all standards-based SOAP API’s, the Taleo Business Edition API definition is available on
the Web Service as an XML-formatted WSDL file. Two WSDL’s are required for integrating with
Taleo Business Edition:
1. DispatcherAPI: http://tbe.taleo.net/wsdl/DispatcherAPI.wsdl
2. WebAPI: http://tbe.taleo.net/wsdl/WebAPI.wsdl

The DispatcherAPI WSDL provides one simple function: request the organization code and
receive a response URL of where the account/zone is located in the pool of Taleo Business
Edition servers. The reason for the Dispatcher is that accounts/zones may be moved to a new
server pool for optimal load balancing. The Dispatcher ensures that the client application will
always find the organization zone URL.

The WebAPI WSDL defines all of the Taleo Business Edition calls. For more information on
WSDL(s), see: http://www.w3.org/TR/wsdl.

Free online WSDL readers are available if required. The following is one found on W3:
http://www.w3.org/2000/06/webdata/xslt?xslfile=http://tomi.vanek.sk/xml/wsdl-
viewer.xsl&xmlfile=http://tbe.taleo.net/wsdl/WebAPI.wsdl&transform=Submit#op.d1e
1025.

Importing the WSDLs to Your Development Platform

After you obtain the two Taleo Business Edition WSDLs, import them into your development
environment for building your Web service applications. The import process depends on the
development environment, programmatic language and tools. For example, the Microsoft Visual
Studio development environment handles the tasks automatically.

A good start would be to practice WSDL import and web service call initiations with a generic
web service tool prior to actual coding. Using a tool like SOAPUI (http://soapui.org), which
comes in a freeware and premium licensed version, allows users to create web service projects,
practice requests and test cases. It is highly recommended to go down this path first.

Taleo Business Edition API Guide Page 11


Candidate API Calls
getCandidateById Element:

NOTE: Taleo assumes you are familiar with basic programming concepts and already have a
programming development environment set up on your computer.

Getting Started

A typical scenario of using the Taleo Web API is:

1. Customer builds a SOAP client to interact with Taleo Web API.


2. The very first call is made to the Dispatcher API to present valid company code and
obtain entry URL to be used in all subsequent calls. This call is always made to URL
https://tbe.taleo.net/MANAGER/dispatcher/servlet/rpcrouter.
3. SOAP client makes login call to the received company code URL and present valid
credentials of an existing user.
4. Customer’s SOAP client sends various requests to the Taleo Web API This may
include, for example, searching through the candidates or requisitions database,
requesting detailed information on a particular candidate or requisition, creation of
a new candidate record, etc.
5. At the end of the session, customer’s SOAP client logs out of Taleo.

Refer to the ‘Login API Calls’ section for details on logging in and logging out of Taleo Business
Edition.

Error Tracing

Most issues can be resolved in minutes if the XML error can be provided. Web API errors may
occur during the communication process, which will not provide the error log within Taleo
Business Edition for Taleo’s support team to analyze. In addition, a programmer is shielded from
the XML trace. As such, it is essential to trace the communication between the client and Taleo
Business Edition API, through third-party tools like tcpmon (https://tcpmon.dev.java.net/).
tcpmon is an open-source utility for monitoring the data flowing on a TCP connection. tcpmon is
used by placing it in-between a client and a server. The client is made to connect to tcpmon, and
tcpmon forwards the data to server along-with displaying it in its GUI.

Note: It is up to the client programmer to be sure that any value assigned to a string field of a
bean is compliant with the W3C XML spec. Please ensure control or bad characters (i.e. #xC) are
shielded from field elements.

Taleo Business Edition API Guide Page 12


Candidate API Calls
getCandidateById Element:

API Simple Data Objects (Beans)


The Taleo Web API uses the following simple data objects to send and receive information:
 accountBean
 attachmentBean
 backgroundCheckBean
 calendarEventBean
 candidateBean
 contactBean
 contactLogBean
 employeeBean
 flexFieldBean
 historyBean
 interviewBean
 offerBean
 participantBean
 referenceBean
 requisitionBean
 searchResultBean
 taskBean
 userBean

Important Notes on Data Transfer:

 Binary candidate resumes and offer letters are sent and received as array of bytes
wrapped into ByteArr.
 Values from pick lists, such as candidate Source or State/Region are transferred as
strings, although on the server side they are stored as ID numbers. This is done because
server side ID numbers are meaningless for external clients. These string values can be
ERP codes assigned to lookup values or display labels. This also assumes that all values
from pick lists have unique display labels.
 To identify user Web API uses login name. For instance, to assign requisition’s approvers,
Web API takes a list of login names.
 There are several fields which cannot be modified by the client, for example: an object’s
unique id #, creation date, and last modified date. These fields are marked “read-only”
in the tables below.
 When an object is created or modified, the same policy is applied as if the object is
created/modified by a user using Taleo through the standard browser interface. For
instance, an attached file must meet security requirements, all mandatory fields
specified for a given candidate must be present, etc. If required conditions are not met

Taleo Business Edition API Guide Page 13


Candidate API Calls
getCandidateById Element:

in any given transaction sent by the client, the operation will fail and a SOAP failure
response will be generated.
 Arrays of returned objects are wrapped in special beans such as SearchResultsArr and
HistoryBeanArr.

Required Fields

Fields marked as “required” in Administration section (both standard and custom) are also
required in Web API. Fields which are always required are marked in the sections below. If the
Web API client is trying to create an object without supplying all required fields, an exception will
be thrown.

XML Data Types

Taleo Business Edition SOAP API data types are based on the XML data types shown below.

 Boolean - A logical value, including true, false, 0, and 1.


 dateTime Date/time values (timestamps).
 double - Numeric value
 int - Numeric value
 string - Any character data
 long – Server side value

Account API Calls


Accounts are the companies and organizations involved with your business such as employers,
customers, search firms, agencies, etc.

accountBean Definition:

Data Field Name Data Field Type Required Acceptable Values


id Long Read Only Account’s unique
server side ID. Can be
obtained by searching
the accounts’
database or by
creating a new

Taleo Business Edition API Guide Page 14


Candidate API Calls
getCandidateById Element:

account.
status String No Account’s Status from
pick list

name String Yes Account’s name

parentAccountId long No ID of parent account

type String No Account’s type (from


pick list)

industry String No Industry (from pick


list)

phone String No Phone number

fax String No Fax number

website String No Web site URL

address String No Street portion of


mailing address
city String No City name

zipCode String No ZIP or postal code

state String No State, region or


province name from
pick list
country String No Country code from
pick list
description String No Account’s description

creationDate Date Read Only Creation date

lastUpdated Date Read Only Last updated date

Taleo Business Edition API Guide Page 15


Candidate API Calls
getCandidateById Element:

flexValues FlexFieldBean[] No Array of flexible


(custom) field values

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue Boolean No Value of Check Box field
DateValue Date No Value of Date field

createAccount Element:

Operation type: Request-response.


 The endpoint receives a message to create an account, and sends a correlated message
of account ID.

Input: createAccountRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 accountBean[] * flexValues []
status
address
city
country
description
fax
industry
name *
parent
phone
state
type

Taleo Business Edition API Guide Page 16


Candidate API Calls
getCandidateById Element:

website
zipCode

Output: createAccountResponse

Data Field Name Data Field Type Required Acceptable Values


createAccountReturn Long Yes Provided Account ID

createAccount Test Case:

Input: createAccountRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createAccount>
<in0>webapi-8483625119411683650</in0>
<in1>
<flexValues>
<!--Zero or more repetitions :-->
<item>
<fieldName>inSalesForce</fieldName>
<valueBool>false</valueBool>
</item>
</flexValues>
<address>99 Seymour</address>
<city>San Paolo</city>
<country>Brazil</country>
<description>TESTING</description>
<fax>894-439-0404</fax>
<industry>Aerospace</industry>
<name>Brazil Aero</name>
<phone>894-439-0404</phone>
<type>Partner</type>
<webSite>www.brazil.com</webSite>
</in1>
</urn:createAccount>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 17


Candidate API Calls
getCandidateById Element:

Output: createAccountResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createAccountResponse xmlns="urn:TBEWebAPI">
<createAccountReturn xmlns="">1</createAccountReturn>
</createAccountResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteAccount Element:

Operation type: Request-response.


 The endpoint receives a message to delete an account, and sends a correlated message
only if error occurred.

Input: deleteAccountRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Account ID Yes ID of Account

Output: deleteAccountResponse

Data Field Name Data Field Type Required Acceptable Values


deleteAccountReturn

deleteAccount Test Case:

Input: deleteAccountRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteAccount>

Taleo Business Edition API Guide Page 18


Candidate API Calls
getCandidateById Element:

<in0>webapi-8483625119411683650</in0>
<in1>1</in1>
</urn:deleteAccount>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteAccountResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteAccountResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getAccountById Element:

Operation type: Request-response.


 The endpoint receives a message to get an account details, and sends a correlated
message of Account information.

Input: getAccountByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Account ID Yes ID of Account

Output: getAccountByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getAccountByIdReturn accountBean []

getAccountById Test Case:

Input: getAccountByIdRequest

Taleo Business Edition API Guide Page 19


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getAccountById>
<in0>webapi-8483625119411683650</in0>
<in1>2</in1>
</urn:getAccountById>
</soapenv:Body>
</soapenv:Envelope>

Output: getAccountByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getAccountByIdResponse xmlns="urn:TBEWebAPI">
<getAccountByIdReturn xmlns="">
<creationDate>2009-08-20T20:47:36.123Z</creationDate>
<flexValues/>
<id>2</id>
<lastUpdated>2009-08-20T20:47:36.123Z</lastUpdated>
<status>Created</status>
<address>99 Seymour</address>
<city>San Paolo</city>
<country>Brazil</country>
<description>TESTING</description>
<fax>894-439-0404</fax>
<industry>Aerospace</industry>
<name>Brazil Aero</name>
<parentAccountId>0</parentAccountId>
<phone>894-439-0404</phone>
<state xsi:nil="true"/>
<type>Partner</type>
<webSite>www.brazil.com</webSite>
<zipCode xsi:nil="true"/>
</getAccountByIdReturn>
</getAccountByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 20


Candidate API Calls
getCandidateById Element:

getAccountHistory Element:

Operation type: Request-response.


 The endpoint receives a message to get an account history, and sends a correlated
message of Account history information.
 This object is used to fetch a history log entry which reflects a past event or action
related to accounts. History records can only be created by the server, they cannot be
modified or deleted. History log includes server side ID, test describing history record,
complete text of email message (for email events) and creation date.

Input: getAccountHistoryRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of Account

Output: getAccountHistoryResponse

Data Field Name Data Field Type Required Acceptable Values


getAccountHistoryReturn historyBean []

getAccountHistory Test Case:

Input: getAccountHistoryRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getAccountHistory>
<in0>webapi-8483625119411683650</in0>
<in1>2</in1>
</urn:getAccountHistory>
</soapenv:Body>
</soapenv:Envelope>

Output: getAccountHistoryResponse

Taleo Business Edition API Guide Page 21


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getAccountHistoryResponse xmlns="urn:TBEWebAPI">
<getAccountHistoryReturn xmlns="">
<array>
<item>
<creationDate>2009-08-20T20:47:36.123Z</creationDate>
<emailText xsi:nil="true"/>
<id>502</id>
<text>Account created</text>
<userName>skarim</userName>
</item>
</array>
</getAccountHistoryReturn>
</getAccountHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>

searchAccount Element:

Operation type: Request-response.


 The endpoint receives a message to query all accounts based on defined key (field
name) and value (data looking for), and sends a correlated message of Account ID and
associated search relevance.
 Relevance is a value between 0 and 100, which reflects how well the account matches
the search criteria
 Map of search parameters always contains:
o key: name of field to search as a string
o value: search parameter as string.
 Format of search value may differ depending on data type of the search field:
 For text, text area, email, URL fields: simple text to be found (case-insensitive) in this
field. Example:
o key=”city”, value=”Francisco” will search for all candidates with ”Francisco” in
“city” field.
 For integer, double, currency: interval between two numbers separated by ‘|’ character.
Either left (from) or right (to) side can be omitted. Example:
o key=”rank”, value=”100|” will search for all candidates with rank value no less
than 100.

Taleo Business Edition API Guide Page 22


Candidate API Calls
getCandidateById Element:

o key=”rank”, value=”|200” will search for all candidates with rank value no more
than 200.
o key=”rank”, value=”100|200” will search for all candidates with rank value
between 100 and 200 (inclusive).
 For date fields: interval between two dates in ISO yyyy-MM-dd format, separated by ‘|’
character. Either left (from) or right (to) side can be omitted. Example:
o key=”startDate”, value=”2004-06-01|” will search for all candidates with start
date on or after June 1st 2004.
o key=”startDate”, value=”|2004-08-01” will search for all candidates with start
date on or before August 1st 2004.
o key=”startDate”, value=”2004-06-01|2004-08-01” will search for all candidates
with start date between June 1st 2004 and August 1st 2004 (inclusive).
 For date interval fields: number of days from today to the past. Example:
o key=” addedWithin”, value=”7” will search for all candidates added to the
system within the last week.
 For single pick list: code value or name of selected item. Example:
o key=”country”, value=”US” will search for all candidates with country field equals
to “United States”.
o key=”status”, value=”available” will search for all candidates in “Available” status.
 For multiple pick list: code values or names of selected items, separated by ‘|’ character.
Example:
o key=”customMultiple”, value=”A1|B2|X5” will search for all candidates with
customMultiple field containing one or more of values: A1, B2, X5.
 For check box fields: “true” if check box must be checked, “false” is unchecked. Example:
o key=” flagged”, value=”true” will search for all candidates “flagged” for the user
currently logged in.
 Search keys names and types can be found in Administration>Customize>Account Fields.
They may include both system fields (listed below for convenience) and custom fields.
For custom fields External name is used as key name.

System Search Keys:

Data Field Name Parameter Type Description


Keyword(s) in account’s description.
keyword String Identical syntax as used in Taleo browser
interface.
name String Account’s name
parentAccountId String ID of parent account
type String Account’s type
industry String Industry
phoneAll String Any account’s phone number
city Pick list City name

Taleo Business Edition API Guide Page 23


Candidate API Calls
getCandidateById Element:

state String State, region or province name from pick


list
country
String Country code from pick list

addedWithin
Integer Added within N days
updatedWithin
Integer Updated within N days

Input: searchAccountRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
key
in1 Item… Yes
value

Output: searchAccountResponse

Data Field Name Data Field Type Required Acceptable Values


searchAccountReturn searchResultBean []

searchAccount Test Case:

Input: searchAccountRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:searchAccount>
<in0>webapi-8483625119411683650</in0>
<in1>
<!--Zero or more repetitions:-->
<item>
<key>type</key>
<value>partner</value>
</item>

Taleo Business Edition API Guide Page 24


Candidate API Calls
getCandidateById Element:

</in1>
</urn:searchAccount>
</soapenv:Body>
</soapenv:Envelope>

Output: searchAccountResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<searchAccountResponse xmlns="urn:TBEWebAPI">
<searchAccountReturn xmlns="">
<array>
<item>
<id>2</id>
<relevance>1.0</relevance>
</item>
</array>
</searchAccountReturn>
</searchAccountResponse>
</soapenv:Body>
</soapenv:Envelope>

updateAccount Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing account, and sends a correlated
message only if error occurred.
 Please Note: Update requests replace all data fields in the accountBean (i.e. data is not
appended or upserted). Send all elements back or the field values will be returned NULL.

Input:updateAccountRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 accountBean[] * flexValues
id *
status
address

Taleo Business Edition API Guide Page 25


Candidate API Calls
getCandidateById Element:

city
country
description
fax
industry
name *
parent
phone
state
type
website
zipCode

Output: updateAccountResponse

Data Field Name Data Field Type Required Acceptable Values


updateAccountReturn

updateAccount Test Case:

Input: updateAccountRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateAccount>
<in0>webapi-5507217897911844945</in0>
<in1>
<flexValues>
<!--Zero or more repetitions :-->
<item>
<fieldName>inSalesForce</fieldName>
<valueBool>true</valueBool>
</item>
</flexValues>
<id>2</id>
<address>4000 Railroad Road</address>
<city>San Paolo</city>
<country>Brazil</country>
<description>TESTING</description>

Taleo Business Edition API Guide Page 26


Candidate API Calls
getCandidateById Element:

<fax>894-439-0404</fax>
<industry>Aerospace</industry>
<name>Brazil Aero</name>
<phone>894-439-0404</phone>
<type>Partner</type>
<webSite>www.brazil.com</webSite>
</in1>
</urn:updateAccount>
</soapenv:Body>
</soapenv:Envelope>

Output: updateAccountResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateAccountResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 27


Candidate API Calls
getCandidateById Element:

Attachment API Calls


Attachments are all of the appended files associated with any entity in Taleo Business Edition.
There is a one-to-many relationship with attachments to entities. Entities include accounts
(ACCT), candidates (CAND), contacts (CTCT), employees (EMPL), requisitions (REQU) and users
(WORK).

attachmentBean Definition:

Data Field
Data Field Name Required Acceptable Values
Type
id Long Read Only Attachment’s unique server side ID.
Type of related entity:
ACCT = accounts
CAND = candidates
entityType String CTCT = contacts
EMPL = employees
REQU = requisitions
WORK = users
entityId Long ID of associated entity
description String Description of the file
filename String Binary File Name
Text = text/plain
html = text/html
RTF = text/richtext
Word = application/msword
contentType String
DocX =
application/vnd.openxmlformats-
officedocument.wordprocessingml.document
PDF = application/pdf
data ByteArr base64Binary []
creationDate Date Read Only Date attachment was created

createAttachment Element:

Operation type: Request-response.


 The endpoint receives a message to create an attachment for a specific candidate, and
sends a correlated message of attachment ID.

Taleo Business Edition API Guide Page 28


Candidate API Calls
getCandidateById Element:

Input: createAttachmentRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes Candidate ID
Attachment
in2 String Yes
Description
in3 String Yes Attachment Name
in4 String Yes contentType
in5 ByteArr Yes binaryResume

Output: createAttachmentResponse

Data Field Name Data Field Type Required Acceptable Values


Provided Attachment
createAttachmentReturn Long Yes
ID

createAttachment Test Case:

Input: createAttachmentRequest

soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createAttachment>
<in0>webapi-5616904436472928038</in0>
<in1>15</in1>
<in2>test1.docx</in2>
<in3>test1.docx</in3>
<in4>application/vnd.openxmlformats-
officedocument.wordprocessingml.document</in4>
<in5>
<!--type: base64Binary-->
<array>JVBERi0xLjQNJeLjz9MNCjYgMCBvYmogPDwvTGluZWFyaX==</array>
</in5>
</urn:createAttachment>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 29


Candidate API Calls
getCandidateById Element:

Output: createAttachmentResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createAttachmentResponse xmlns="urn:TBEWebAPI">
<createAttachmentReturn xmlns="">154</createAttachmentReturn>
</createAttachmentResponse>
</soapenv:Body>
</soapenv:Envelope>

createEntityAttachment Element:

Operation type: Request-response.


 The endpoint receives a message to create an attachment for a specific ID associated
with a specific entity (i.e. Candidate, Employee, Account, etc.), and sends a correlated
message of attachment ID.

Input: createEntityAttachmentRequest

Data Field
Data Field Name Required Acceptable Values
Type
sessionId Long Read Only Attachment’s unique server side ID.
Type of related entity:
ACCT = accounts
CAND = candidates
entityType String
EMPL = employees
REQU = requisitions
WORK = users
entityId Long ID of associated entity
description String Description of the file
filename String Binary File Name
Text = text/plain
html = text/html
RTF = text/richtext
Word = application/msword
contentType String
DocX =
application/vnd.openxmlformats-
officedocument.wordprocessingml.document
PDF = application/pdf
data ByteArr base64Binary []

Taleo Business Edition API Guide Page 30


Candidate API Calls
getCandidateById Element:

Output: createEntityAttachmentResponse

Data Field Name Data Field Type Required Acceptable Values


Provided
createEntityAttachmentReturn Long Yes
Attachment ID

createEntityAttachment Test Case:

Input: createEntityAttachmentRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createEntityAttachment>
<sessionId>webapi8668622358131845860</sessionId>
<entityType>REQU</entityType>
<entityId>69</entityId>
<description>pdfAttachment</description>
<fileName>new.pdf</fileName>
<contentType>application/pdf</contentType>
<data>
<!--type: base64Binary-->
<array>JVBERi0xLjQNJeLjz9MNCjYgMCBvYmogPDwvTGluZWFyaXplZCAxL0wgMTg3NT==</array
>
</data>
</urn:createEntityAttachment>
</soapenv:Body>
</soapenv:Envelope>

Output: createEntityAttachmentResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createEntityAttachmentResponse xmlns="urn:TBEWebAPI">
<createEntityAttachmentReturn xmlns="">157</createEntityAttachmentReturn>
</createEntityAttachmentResponse>

Taleo Business Edition API Guide Page 31


Candidate API Calls
getCandidateById Element:

</soapenv:Body>
</soapenv:Envelope>

deleteAttachment Element:

Operation type: Request-response.


 The endpoint receives a message to delete an attachment, and sends a correlated
message only if error occurred.

Input: deleteAttachmentRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of attachment

Output: deleteAttachmentResponse

Data Field Name Data Field Type Required Acceptable Values


deleteAttachmentReturn

deleteAttachment Test Case:

Input: deleteAttachmentRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteAttachment>
<in0>webapi9172860277027829324</in0>
<in1>8</in1>
</urn:deleteAttachment>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteAttachmentResponse

Taleo Business Edition API Guide Page 32


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteAttachmentResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getAttachment Element:

Operation type: Request-response.


 The endpoint receives a message to get an attachment by attachment ID, and sends a
correlated message of attachment name, type, creation date and ID.

Input: getAttachmentRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of attachment

Output: getAttachmentResponse

Data Field Name Data Field Type Required Acceptable Values


getAttachmentReturn attachmentBean []

getAttachment Test Case:

Input: getAttachmentRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getAttachment>
<in0>webapi1673199911353581754</in0>
<in1>3</in1>
</urn:getAttachment>
</soapenv:Body>

Taleo Business Edition API Guide Page 33


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

Output: getAttachmentResponse

<soapenv:Body>
<getAttachmentResponse xmlns="urn:TBEWebAPI">
<getAttachmentReturn xmlns="">
<contentType>application/vnd.openxmlformats-
officedocument.wordprocessingml.document</contentType>
<creationDate>2009-09-04T18:33:50.830Z</creationDate>
<description>file_7896653827536535960.docx</description>
<id>3</id>
</getAttachmentReturn>
</getAttachmentResponse>
</soapenv:Body>
</soapenv:Envelope>

getAttachmentData Element:

Operation type: Request-response.


 The endpoint receives a message to get attachment data by ID, and sends the correlated
binary attachment data.

Input: getAttachmentDataRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of attachment

Output: getAttachmentDataResponse

Data Field Name Data Field Type Required Acceptable Values


getAttachmentDataReturn base64Binary []

getAttachmentData Test Case:

Input: getAttachmentDataRequest

Taleo Business Edition API Guide Page 34


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getAttachmentData>
<in0>webapi1673199911353581754</in0>
<in1>3</in1>
</urn:getAttachmentData>
</soapenv:Body>
</soapenv:Envelope>

Output: getAttachmentDataResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getAttachmentDataResponse xmlns="urn:TBEWebAPI">
<getAttachmentDataReturn xmlns="">
<array>UEsDBBQABgAIAAAAIQAwySgMcgEAAKUFAAATAAgC ==</array>
</getAttachmentDataReturn>
</getAttachmentDataResponse>
</soapenv:Body>
</soapenv:Envelope>

getAttachments Element:

Operation type: Request-response.


 The endpoint receives a message to get attachment(s) associated with a candidate, and
sends back attachment IDs.

Input: getAttachmentsRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of candidate

Output: getAttachmentsResponse

Taleo Business Edition API Guide Page 35


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


getAttachmentReturn array of attachment IDs

getAttachments Test Case:

Input: getAttachmentsRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getAttachments>
<in0>webapi1673199911353581754</in0>
<in1>48</in1>
</urn:getAttachments>
</soapenv:Body>
</soapenv:Envelope>

Output: getAttachmentsResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getAttachmentsResponse xmlns="urn:TBEWebAPI">
<getAttachmentsReturn xmlns="">
<array>
<item>4</item>
<item>3</item>
</array>
</getAttachmentsReturn>
</getAttachmentsResponse>
</soapenv:Body>
</soapenv:Envelope>

getEntityAttachments Element:

Taleo Business Edition API Guide Page 36


Candidate API Calls
getCandidateById Element:

Operation type: Request-response.


 The endpoint receives a message to get attachment(s) associated with any Taleo
Business Edition entity that supports attachment upload, and sends back attachment IDs
associated with the entity ID.

Input: getEntityAttachmentsRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
Type of related entity:
ACCT = accounts
CAND = candidates
entityType Long Yes
EMPL = employees
REQU = requisitions
WORK = users
entityID Long Yes ID of associated entity

Output: getEntityAttachmentsResponse

Data Field Name Data Field Type Required Acceptable Values


getEntityAttachmentReturn array of attachment IDs

getEntityAttachments Test Case:

Input: getEntityAttachmentsRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getEntityAttachments>
<sessionId>webapi4356913335216569919</sessionId>
<entityType>REQU</entityType>
<entityId>69</entityId>
</urn:getEntityAttachments>
</soapenv:Body>
</soapenv:Envelope>

Output: getEntityAttachmentsResponse

Taleo Business Edition API Guide Page 37


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getEntityAttachmentsResponse xmlns="urn:TBEWebAPI">
<getEntityAttachmentsReturn xmlns="">
<array>
<item>7</item>
<item>1</item>
</array>
</getEntityAttachmentsReturn>
</getEntityAttachmentsResponse>
</soapenv:Body>
</soapenv:Envelope>

updateAttachment Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing attachment, and sends a
correlated message only if error occurred.
 Please Note: Update requests replaces the attachment file (i.e. data is not appended or
upserted).

Input: updateAttachmentRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes Attachment ID
Attachment
in2 String Yes
Description
in3 String Yes Attachment Name
in4 String Yes contentType
in5 ByteArr Yes binaryResume

Output: updateAttachmentResponse

Data Field Name Data Field Type Required Acceptable Values


updateAttachmentReturn

Taleo Business Edition API Guide Page 38


Candidate API Calls
getCandidateById Element:

updateAttachment Test Case:

Input: updateAttachmentRequest

soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateAttachment>
<in0>webapi-5616904436472928038</in0>
<in1>15</in1>
<in2>test1.docx</in2>
<in3>test1.docx</in3>
<in4>application/vnd.openxmlformats-
officedocument.wordprocessingml.document</in4>
<in5>
<!--type: base64Binary-->
<array>JVBERi0xLjQNJeLjz9MNCjYgMCBvYmogPDwvTGluZWFyaX==</array>
</in5>
</urn:updateAttachment>
</soapenv:Body>
</soapenv:Envelope>

Output: updateAttachmentResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateAttachmentResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Background Check API Calls


Background checks provides background check information that may have occurred for a specific
candidate in Taleo Business Edition. There is a one-to-many relationship with candidates to
background checks.

Taleo Business Edition API Guide Page 39


Candidate API Calls
getCandidateById Element:

backgroundCheckBean Definition:

Data Field Name Data Field Type Required Acceptable Values


Id long Account’s unique
server side ID. Can be
obtained by searching
Read Only the accounts’
database or by
creating a new
account.
Status String No Account’s Status from
pick list
Creator String Yes Creator’s login name
CandidateId long Yes ID of candidate
CheckerName String Yes Name of the checker
CheckerPhone String No Phone of the checker
CheckerEmail String No Email of the checker
Comments String No Comments
CreationDate Date Read Only Creation date
LastUpdated Date Read Only Last updated date
FlexValues FlexFieldBean[] No Array of flexible
(custom) field values

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue Boolean No Value of Check Box field
DateValue Date No Value of Date field

createBackgroundCheck Element:

Taleo Business Edition API Guide Page 40


Candidate API Calls
getCandidateById Element:

Operation type: Request-response.


 The endpoint receives a message to create a background check, and sends a correlated
message of background check ID.

Input:createBackgroundCheckRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
CandidateId *
CheckerName *
in1 backgroundCheckBean[] * CheckerPhone
CheckerEmail
Comments *
Status

Output: createBackgroundCheckResponse

Data Field Name Data Field Type Required Acceptable Values


Provided
createBackgroundCheckReturn Long Yes Background Check
ID

createBackgroundCheck Test Case:

Input: createBackgroundCheck Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createBackgroundCheck>
<in0>webapi1673199911353581754</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<candidateId>48</candidateId>
<checkerEmail>[email protected]</checkerEmail>
<checkerName>Intellius Background</checkerName>
<checkerPhone>630-345-6978</checkerPhone>

Taleo Business Edition API Guide Page 41


Candidate API Calls
getCandidateById Element:

<comments>Package 1 background check process</comments>


</in1>
</urn:createBackgroundCheck>
</soapenv:Body>
</soapenv:Envelope>

Output: createBackgroundCheckResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createBackgroundCheckResponse xmlns="urn:TBEWebAPI">
<createBackgroundCheckReturn xmlns="">2</createBackgroundCheckReturn>
</createBackgroundCheckResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteBackgroundCheck Element:

Operation type: Request-response.


 The endpoint receives a message to delete a background check instance, and sends a
correlated message only if error occurred.

Input: deleteBackgroundCheckRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
ID of Background
in1 Background Check ID Yes
Check

Output: deleteBackgroundCheckResponse

Data Field Name Data Field Type Required Acceptable Values


deleteBackgroundCheckReturn

deleteBackgroundCheck Test Case:

Taleo Business Edition API Guide Page 42


Candidate API Calls
getCandidateById Element:

Input: deleteBackgroundCheckResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteBackgroundCheck>
<in0>webapi1673199911353581754</in0>
<in1>3</in1>
</urn:deleteBackgroundCheck>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteBackgroundCheckResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteBackgroundCheckResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getBackgroundCheckById Element:

Operation type: Request-response.


 The endpoint receives a message to get a specific background check by ID, and sends a
correlated message of information associated with that background check instance.

Input: getBackgroundCheckByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
ID of Background
in1 BackgroundCheck ID Yes
Check

Output: getBackgroundCheckByIdResponse

Taleo Business Edition API Guide Page 43


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable


Values
getBackgroundCheckByIdReturn
backgroundCheckBean
[]

getBackgroundCheckById Test Case:

Input: getBackgroundCheckByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getBackgroundCheckById>
<in0>webapi1673199911353581754</in0>
<in1>4</in1>
</urn:getBackgroundCheckById>
</soapenv:Body>
</soapenv:Envelope>

Output: getBackgroundCheckByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getBackgroundCheckByIdResponse xmlns="urn:TBEWebAPI">
<getBackgroundCheckByIdReturn xmlns="">
<creationDate>2009-09-10T01:38:24.470Z</creationDate>
<flexValues>
<item>
<fieldName>BackgroundCheckURL</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong>www.intellius.com/report</valueLong>
<valueStr xsi:nil="true"/>
</item>
</flexValues>
<id>4</id>
<lastUpdated>2009-09-10T01:38:24.470Z</lastUpdated>

Taleo Business Edition API Guide Page 44


Candidate API Calls
getCandidateById Element:

<status>Submitted</status>
<candidateId>48</candidateId>
<checkerEmail>[email protected]</checkerEmail>
<checkerName>Intellius Background Checks</checkerName>
<checkerPhone>630-345-6978</checkerPhone>
<comments>Package 3 background check process</comments>
<creator>skarim</creator>
</getBackgroundCheckByIdReturn>
</getBackgroundCheckByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

getBackgroundChecksByCandidate Element:

Operation type: Request-response.


 The endpoint receives a message to get all background checks for a specific Candidate
ID, and sends a message of all background check IDs.

Input: getBackgroundChecksByCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Candidate ID Yes ID of Candidate

Output: getBackgroundChecksByCandidateResponse

Required Acceptable
Data Field Name Data Field Type
Values
Background
getBackgroundChecksByCandidateReturn
Check ID(s)

getBackgroundChecksByCandidate Test Case:

Input: getBackgroundChecksByCandidateRequest

Taleo Business Edition API Guide Page 45


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getBackgroundChecksByCandidate>
<in0>webapi1673199911353581754</in0>
<in1>48</in1>
</urn:getBackgroundChecksByCandidate>
</soapenv:Body>
</soapenv:Envelope>

Output: getBackgroundChecksByCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getBackgroundChecksByCandidateResponse xmlns="urn:TBEWebAPI">
<getBackgroundChecksByCandidateReturn xmlns="">
<array>
<item>4</item>
<item>2</item>
</array>
</getBackgroundChecksByCandidateReturn>
</getBackgroundChecksByCandidateResponse>
</soapenv:Body>
</soapenv:Envelope>

updateBackgroundCheck Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing backgroundcheck instance, and
sends a correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the backgroundCheckBean (i.e.
data is not appended or upserted). Send all elements back or the field values will be
returned NULL.

Input:updateBackgroundCheckRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Session ID received at

Taleo Business Edition API Guide Page 46


Candidate API Calls
getCandidateById Element:

Login
ID
candidateID
flexValues []
CandidateId *
CheckerName *
in1 backgroundCheckBean[] *
CheckerPhone
CheckerEmail
Comments *
Status
Creator

Output: updateBackgroundCheckResponse

Data Field Name Data Field Type Required Acceptable Values


updateBackgroundCheckReturn

updateBackgroundCheck Test Case:

Input: updateBackgroundCheckRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateBackgroundCheck>
<in0>webapi1673199911353581754</in0>
<in1>
<id>4</id>
<status>Submitted</status>
<candidateId>48</candidateId>
<checkerEmail>[email protected]</checkerEmail>
<checkerName>Intellius</checkerName>
<checkerPhone>323-434-3434</checkerPhone>
<comments>Package 8</comments>
<creator>skarim</creator>
</in1>
</urn:updateBackgroundCheck>
</soapenv:Body>
</soapenv:Envelope>

Input: updateBackgroundCheckRequest

Taleo Business Edition API Guide Page 47


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateBackgroundCheckResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Candidate API Calls


Candidates are all of the people you want to track in Taleo Business Edition who are (either)
applicants, employee referrals, sourced prospects, agency submissions, etc.

candidateBean Definition:

Data Field Name Data Field Type Required Acceptable Values


Id long Candidate’s unique
server side ID. Can be
obtained by searching
Read Only the candidate
database or by
creating a new
candidate.
status String Yes Candidate’s Status
name from pick list
firstName String No First name
middleInitial String No Middle name
lastName String Yes Last name
address String No Street portion of
mailing address
city String No City name
zipCode String No ZIP or postal code
state String No State, region or
province name from
pick list
country String No Country code from
pick list

Taleo Business Edition API Guide Page 48


Candidate API Calls
getCandidateById Element:

email String Yes Candidate’s email


address
phone String No Phone number

cellPhone String No Mobile phone number

source String No Candidate’s Source


name from pick list
submittedBy String No Login name of agency
which has submitted
this candidate
referredBy String No Name of the
employee who has
referred this
candidate
legalStatus String No Candidate’s legal
status name from pick
list
gender String No Gender name from
pick list
race String No Race name from pick
list
veteran String No Veteran status name
from pick list
rank int No Candidate’s rank
based on ranking
criteria
hiredDate Date No Date of hire
startDate Date No Start of employment
date
textResume String No Text resume and/or
cover letter
resumeFileName String Read Only Binary resume file
name
reasonRejected String No Candidate’s reason for
rejection from pick list
cwsPassword String No Password chosen on
Careers Web Site
creationDate Date Read Only Creation date
lastUpdated Date Read Only Last updated date
flexValues FlexFieldBean[] No Array of flexible

Taleo Business Edition API Guide Page 49


Candidate API Calls
getCandidateById Element:

(custom) field values

candidateDetailsBean Definition:

(This object is used to fetch detailed candidate information, including related objects)

Data Field Name Data Field Type Required Acceptable Values


candidateBean candidateBean [] Yes Candidate information
requisitionBean requisitionBean[] No Requisitions
associated with the
candidate
interviewBean interviewBean[] No Interviews associated
with the candidate
referenceBeans referenceBean[] No References associated
with the candidate
historyBean historyBean[] No History records
associated with the
candidate
attachmentBean attachmentBean[] No Attachments
associated with the
candidate
offerBean offerBean [] No Offers associated with
the candidate

candidateWorkHistoryBean Definition:

Data Field Name Data Field Type Required Acceptable Values


Id long Work History’s unique
Read Only
server side ID.
entityId long Read Only ID for the candidate
that owns this
workhistory entity
seqNo int No Sequences of the
workhistory relative
to other entries
(could be used for
sorting)
jobTitle String No Job Title
companyName String No Company Name
dateFrom Date No Start Date

Taleo Business Edition API Guide Page 50


Candidate API Calls
getCandidateById Element:

dateTo Date No End Date


jobDescription String No Job Description

companyStreetAddress String No Company’s street


address

companyCityState String No Company’s street


address

phone String No Company’s phone


number

directSupervisor String No Name of the


supervisor

supervisorTitle String No Title of the supervisor

explanation String No General description

finalRateOfPay String No Final salary

okToContact Boolean No Ok to contact the


company
reasonForLeaving String No Reason for leaving
(picklist)
creationDate Date Read Only Creation date

lastUpdated Date Read Only Last updated date

FlexValues FlexFieldBean[] No Array of flexible


(custom) field values

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name

Taleo Business Edition API Guide Page 51


Candidate API Calls
getCandidateById Element:

FieldName String Yes Field name


StringValue
Value of Text, Email, URL, Pick list, or Text
String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue
int No Value of Integer field

DoubleValue
double No Value of Decimal or Currency field

BooleanValue
Boolean No Value of Check Box field

DateValue
Date No Value of Date field

createCandidate Element:

Operation type: Request-response.


 The endpoint receives a message to create a candidate, and sends a correlated message
of candidate ID.

Input:createCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 candidateBean[] * flexValues []
status *
address
cellPhone
city
country
email *
firstName
gender
hiredDate

Taleo Business Edition API Guide Page 52


Candidate API Calls
getCandidateById Element:

lastName *
legalStatus
middleInitial
password
phone
race
rank
reasonRejected
referredBy
resumeFileName
source
startDate
state
submittedBy
textResume
veteren
zipCode

Output: createCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


createCandidateReturn Long Yes Provided Candidate ID

createCandidate Test Case:

Input:createCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createCandidate>
<in0>webapi1964799883250105794</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<status>Hired</status>
<address>2323 Macaroni Road</address>
<cellPhone>999-343-2344</cellPhone>
<city>Jason</city>
<country>US-CA</country>

Taleo Business Edition API Guide Page 53


Candidate API Calls
getCandidateById Element:

<email>[email protected]</email>
<firstName>Jessica</firstName>
<gender>Choose Not to Disclose</gender>
<hiredDate>2009-09-04T18:33:50.830Z</hiredDate>
<lastName>Karim</lastName>
<legalStatus>My status to work in this country is unknown</legalStatus>
<middleInitial>H</middleInitial>
<password>jason</password>
<phone>748-232-2323</phone>
<race>Hispanic or Latino</race>
<rank>100</rank>
<reasonRejected>Position was canceled</reasonRejected>
<referredBy>skarim</referredBy>
<source>Other</source>
<startDate>2009-09-04T18:33:50.830Z</startDate>
<state>US-CA</state>
<submittedBy>skarim</submittedBy>
<textResume>Skilled in after school specials</textResume>
<veteran>Armed Forces Service Medal Veterans</veteran>
<zipCode>93045</zipCode>
</in1>
</urn:createCandidate>
</soapenv:Body>
</soapenv:Envelope>

Output: createCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createCandidateResponse xmlns="urn:TBEWebAPI">
<createCandidateReturn xmlns="">49</createCandidateReturn>
</createCandidateResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteCandidate Element:

Operation type: Request-response.

Taleo Business Edition API Guide Page 54


Candidate API Calls
getCandidateById Element:

 The endpoint receives a message to delete a candidate, and sends a correlated message
only if error occurred.

Input: deleteCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Candidate ID Yes ID of Candidate

Output: deleteCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


deleteCandidateReturn

deleteCandidate Test Case:

Input: deleteCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteCandidate>
<in0>webapi1964799883250105794</in0>
<in1>46</in1>
</urn:deleteCandidate>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteCandidateResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 55


Candidate API Calls
getCandidateById Element:

getCandidateById Element:

Operation type: Request-response.


 The endpoint receives a message to get a candidate general information by ID, and
sends a correlated message of Candidate information.
 For full candidate details, including offers, references, attachments, etc., use
getCandidateDetailsById call.

Input: getCandidateByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Candidate ID Yes ID of Contact

Output: getCandidateByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getCandidateByIdReturn candidateBean []

getCandidateById Test Case:

Input: getCandidateByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getCandidateById>
<in0>webapi-7865850650124675561</in0>
<in1>48</in1>
</urn:getCandidateById>
</soapenv:Body>
</soapenv:Envelope>

Output: getCandidateByIdResponse

Taleo Business Edition API Guide Page 56


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getCandidateByIdResponse xmlns="urn:TBEWebAPI">
<getCandidateByIdReturn xmlns="">
<creationDate>2009-09-04T18:33:46.463Z</creationDate>
<flexValues>
<item>
<fieldName/>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>Associates Degree</valueStr>
</item>
<item>
<fieldName>Other (Specify Source)</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr/>
</item>
<item>
<fieldName>Current Salary</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
<item>
<fieldName>ssn</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>

Taleo Business Edition API Guide Page 57


Candidate API Calls
getCandidateById Element:

</flexValues>
<id>48</id>
<lastUpdated>2009-09-04T18:33:46.463Z</lastUpdated>
<status>NEW</status>
<address>12016 194 B Street</address>
<cellPhone/>
<city>Pitt Meadows</city>
<country>Canada</country>
<email>[email protected]</email>
<firstName>Alisha</firstName>
<gender>Female</gender>
<hiredDate xsi:nil="true"/>
<lastName>Smith</lastName>
<legalStatus>I am authorized to work in this country for any employer</legalStatus>
<middleInitial>Alexandra</middleInitial>
<password>basketball</password>
<phone>6043754603</phone>
<race>Asian (not Hispanic or Latino)</race>
<rank>0</rank>
<reasonRejected xsi:nil="true"/>
<referredBy xsi:nil="true"/>
<resumeFileName>resume_48.docx</resumeFileName>
<source>Careers Website</source>
<startDate xsi:nil="true"/>
<state>US-AL</state>
<submittedBy xsi:nil="true"/>
<textResume/>
<veteran>Armed Forces Service Medal Veterans</veteran>
<zipCode>60606</zipCode>
</getCandidateByIdReturn>
</getCandidateByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

getCandidateDetailsById Element:

Operation type: Request-response.


 The endpoint receives a message to get candidate detailed information by ID, and sends
a correlated message of detail Candidate information.
 For general candidate record details, use getCandidateById call.

Taleo Business Edition API Guide Page 58


Candidate API Calls
getCandidateById Element:

Input: getCandidateDetailsByIdRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Session ID
in1 candidateId - Long Yes Candidate ID
in2 includeRequisitions – Yes True
Boolean False
in3 includeInterviews – Yes True
Boolean False
in4 includeReferences – Yes True
Boolean False
in5 includeHistory – Boolean Yes True
False
in6 includeAttachments – Yes True
Boolean False
in7 includeOffers - Boolean Yes True
False

Output: getCandidateDetailsByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getCandidateDetailsByIdReturn candidateDetailsBean []

getCandidateDetailsById Test Case:

Input: getCandidateDetailsByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getCandidateDetailsById>
<in0>webapi-1081039353966410322</in0>
<in1>48</in1>
<in2>True</in2>
<in3>True</in3>
<in4>True</in4>
<in5>True</in5>
<in6>True</in6>

Taleo Business Edition API Guide Page 59


Candidate API Calls
getCandidateById Element:

<in7>True</in7>
</urn:getCandidateDetailsById>
</soapenv:Body>
</soapenv:Envelope>

Output: getCandidateDetailsByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getCandidateDetailsByIdResponse xmlns="urn:TBEWebAPI">
<getCandidateDetailsByIdReturn>
<offerBeans xmlns=""/>
<historyBeans xmlns="">
<item>
<creationDate>2009-09-04T18:39:26.620Z</creationDate>
<emailText>From: [email protected]
To: [email protected]
Subject: Thank you

Thank you for submitting your resume. Our management team is reviewing your qualifications
and will contact you if there is a match with our current open positions.

Meanwhile, using your email address and password, you can login to our careers website
anytime to update your application information.

We appreciate your interest in TaleoSK and wish you the best of luck in your job search.

-------------------------------
Powered by Taleo
www.taleo.com</emailText>
<id>542</id>
<text>Email message Thank you sent to [email protected]</text>
<userName xsi:nil="true"/>
</item>
<item>
<creationDate>2009-09-04T18:34:46.883Z</creationDate>
<emailText xsi:nil="true"/>
<id>528</id>
<text>Candidate (id: 48) (id: 48) Alisha Alexandra Smith has been evaluated against
requisition (id: 14) (id: 14) Bartender - [98079] for a score of: 0.</text>

Taleo Business Edition API Guide Page 60


Candidate API Calls
getCandidateById Element:

<userName xsi:nil="true"/>
</item>
</historyBeans>
<interviewBeans xmlns=""/>
<referenceBeans xmlns=""/>
<attachmentBeans xmlns="">
<item>
<contentType>text/plain</contentType>
<creationDate>2009-09-09T23:43:40.050Z</creationDate>
<description>ConCall Details.txt</description>
<id>4</id>
</item>
</attachmentBeans>
<requisitionBeans xmlns="">
<item>
<creationDate>2009-02-09T23:03:51.430Z</creationDate>
<flexValues>
</flexValues>
<id>11</id>
<lastUpdated>2009-02-18T22:22:18.317Z</lastUpdated>
<status>Open</status>
<city>Dublin</city>
<description><![CDATA[<p>The Pre-Sales Engineer, reporting to the Canadian
Delivery Manager, will be responsible for providing solution architect support to our client's
services sales and pre-sales teams. Solutions are primarily in the area of Electronic Content
Management, Imaging and Document Process Outsourcing. <br />
<br />
This is a role intended to extend the governance of the Delivery organization into the pre-sales
area. This resource will be responsible for defining and validating solutions to be proposed to
new and existing customers. <br />
<br /></p>]]></description>
<duration>FULLTIME</duration>
<filledDate xsi:nil="true"/>
<jobCategory>(2) Professionals</jobCategory>
<jobCode>12345</jobCode>
<location>Headquarters</location>
<numOpen>1</numOpen>
<openedDate>2009-02-09T00:00:00.000Z</openedDate>
<payRange/>
<state>US-CA</state>
<title>Sales Engineer</title>
</item>
</requisitionBeans>
<candidateBean xmlns="">

Taleo Business Edition API Guide Page 61


Candidate API Calls
getCandidateById Element:

<creationDate>2009-09-04T18:33:46.463Z</creationDate>
<flexValues>
<item>
<fieldName>Current Salary</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
</flexValues>
<id>48</id>
<lastUpdated>2009-09-04T18:33:46.463Z</lastUpdated>
<status>NEW</status>
<address>12032 194 B Street</address>
<cellPhone/>
<city>Pitt Meadows</city>
<country>Canada</country>
<email>[email protected]</email>
<firstName>Alisha</firstName>
<gender>Female</gender>
<hiredDate xsi:nil="true"/>
<lastName>Smith</lastName>
<legalStatus>I am authorized to work in this country for any employer</legalStatus>
<middleInitial>Alexandra</middleInitial>
<password>basketball</password>
<phone>6043754606</phone>
<resumeFileName>resume_48.docx</resumeFileName>
<source>Careers Website</source>
<startDate xsi:nil="true"/>
<state>US-AL</state>
<submittedBy xsi:nil="true"/>
<textResume/>
<veteran>Armed Forces Service Medal Veterans</veteran>
<zipCode>60606</zipCode>
</candidateBean>
</getCandidateDetailsByIdReturn>
</getCandidateDetailsByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 62


Candidate API Calls
getCandidateById Element:

getCandidateHistory Element:

Operation type: Request-response.


 The endpoint receives a message to get a Candidate transaction history, and sends a
correlated message of transaction history for the specific candidate ID.
 This object is used to fetch a history log entry which reflects a past event or action
related to candidates. History records can only be created by the server, they cannot be
modified or deleted. History log includes server side ID, test describing history record,
complete text of email message (for email events) and creation date.

Input: getCandidateHistoryRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Candidate ID Yes ID of Candidate

Output: getCandidateHistoryResponse

Data Field Name Data Field Type Required Acceptable Values


getCandidateHistoryReturn historyBean []

getCandidateHistory Test Case:

Input: getCandidateHistoryRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getCandidateHistory>
<in0>webapi-1081039353966410322</in0>
<in1>43</in1>
</urn:getCandidateHistory>
</soapenv:Body>
</soapenv:Envelope>

Output: getCandidateHistoryResponse

Taleo Business Edition API Guide Page 63


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getCandidateHistoryResponse xmlns="urn:TBEWebAPI">
<getCandidateHistoryReturn xmlns="">
<array>
<item>
<creationDate>2009-07-31T18:08:52.397Z</creationDate>
<emailText xsi:nil="true"/>
<id>497</id>
<text>Employee created from Candidate.</text>
<userName>skarim</userName>
</item>
<item>
<creationDate>2009-06-30T23:01:26.493Z</creationDate>
<emailText xsi:nil="true"/>
<id>491</id>
<text>Candidate created</text>
<userName>skarim</userName>
</item>
</array>
</getCandidateHistoryReturn>
</getCandidateHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>

getCandidatesByRequisition Element:

Operation type: Request-response.


 The endpoint receives a message to get all candidates by Requisition ID, and sends a
correlated message of Candidate IDs associated with a specific requisition.

Input: getCandidatesByRequisitionRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Session ID
in1 String Yes Requisition ID

Output: getCandidatesByRequisitionResponse

Taleo Business Edition API Guide Page 64


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


getCandidatesByRequisitionReturn candidate ID(s)

getCandidatesByRequisition Test Case:

Input: getCandidatesByRequisitionRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getCandidatesByRequisition>
<in0>webapi-1081039353966410322</in0>
<in1>14</in1>
</urn:getCandidatesByRequisition>
</soapenv:Body>
</soapenv:Envelope>

Output: getCandidatesByRequisitionResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getCandidatesByRequisitionResponse xmlns="urn:TBEWebAPI">
<getCandidatesByRequisitionReturn xmlns="">
<array>
<item>31</item>
<item>47</item>
<item>48</item>
</array>
</getCandidatesByRequisitionReturn>
</getCandidatesByRequisitionResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 65


Candidate API Calls
getCandidateById Element:

getCandidateWorkHistory Element:

Operation type: Request-response.


 The endpoint receives a message to get the rolling entity specific to a candidate’s work
history form details, and sends a correlated message of work history information.
 The getRollingEnitities request can also be used.
 This is a manually filled in dynamic form that may not be activated in some customer
zones (i.e. configured ON).

Input: getCandidateWorkHistoryRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionId String Yes
Login
candidateId Long Yes ID of Contact

Output: getCandidateWorkHistoryResponse

Required Acceptable
Data Field Name Data Field Type
Values
candidateWorkHistoryBean
getCandidateWorkHistoryReturn
[]

getCandidateWorkHistory Test Case:

Input: getCandidateWorkHistoryRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getCandidateWorkHistory>
<sessionId>webapi-1081039353966410322</sessionId>
<candidateId>48</candidateId>
</urn:getCandidateWorkHistory>
</soapenv:Body>
</soapenv:Envelope>

Output: getCandidateWorkHistoryResponse

Taleo Business Edition API Guide Page 66


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getCandidateWorkHistoryResponse xmlns="urn:TBEWebAPI">
<getCandidateWorkHistoryReturn xmlns="">
<array>
<item>
<creationDate>2009-09-04T18:33:46.463Z</creationDate>
<flexValues>
<item>
<fieldName>Starting Rate Of Pay</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
</flexValues>
<id>28</id>
<lastUpdated>2009-09-04T18:33:46.463Z</lastUpdated>
<status xsi:nil="true"/>
<entityId>48</entityId>
<seqNo>2</seqNo>
<jobTitle>Dr</jobTitle>
<companyName/>
<dateFrom>2009-07-01T00:00:00.000Z</dateFrom>
<dateTo>2009-09-01T00:00:00.000Z</dateTo>
<jobDescription/>
<companyStreetAddress/>
<companyCityState/>
<phone/>
<directSupervisor/>
<supervisorTitle/>
<explanation/>
<finalRateOfPay/>
<okToContact>false</okToContact>
<reasonForLeaving>Terminated</reasonForLeaving>
</item>
<item>
<creationDate>2009-09-04T18:33:46.463Z</creationDate>
<flexValues>
<item>

Taleo Business Edition API Guide Page 67


Candidate API Calls
getCandidateById Element:

<fieldName>Starting Rate Of Pay</fieldName>


<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
</flexValues>
<id>27</id>
<lastUpdated>2009-09-04T18:33:46.463Z</lastUpdated>
<status xsi:nil="true"/>
<entityId>48</entityId>
<seqNo>1</seqNo>
<jobTitle>Dr.</jobTitle>
<companyName/>
<dateFrom>2005-01-01T00:00:00.000Z</dateFrom>
<dateTo>2009-06-01T00:00:00.000Z</dateTo>
<jobDescription/>
<companyStreetAddress/>
<companyCityState/>
<phone/>
<directSupervisor/>
<supervisorTitle/>
<explanation/>
<finalRateOfPay/>
<okToContact>false</okToContact>
<reasonForLeaving xsi:nil="true"/>
</item>
</array>
</getCandidateWorkHistoryReturn>
</getCandidateWorkHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>

getCandReqStatus Element:

Operation type: Request-response.


 The endpoint receives a message to get a status of a requisition for a particular
candidate, and sends a correlated message of the candidate’s specific requisition status.

Taleo Business Edition API Guide Page 68


Candidate API Calls
getCandidateById Element:

 Candidate Requisition Status is picklist created and derived from Taleo Business Edition.

Input: getCandReqStatusRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of Candidate
in2 Long Yes ID of requisition

Output: getCandReqStatusResponse

Data Field Name Data Field Type Required Acceptable Values


Candidate Requisition
getCandReqStatusReturn Long
Status Picklist Values

getCandReqStatus Test Case:

Input: getCandReqStatusRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getCandReqStatus>
<in0>webapi-1081039353966410322</in0>
<in1>48</in1>
<in2>13</in2>
</urn:getCandReqStatus>
</soapenv:Body>
</soapenv:Envelope>

Output: getCandReqStatusResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getCandReqStatusResponse xmlns="urn:TBEWebAPI">
<getCandReqStatusReturn xmlns="">NEW</getCandReqStatusReturn>
</getCandReqStatusResponse>

Taleo Business Edition API Guide Page 69


Candidate API Calls
getCandidateById Element:

</soapenv:Body>
</soapenv:Envelope>

getRequisitions Element:

Operation type: Request-response.


 The endpoint receives a message to get requisition(s) associated with any Taleo Business
Edition candidate, and sends back requisition IDs associated with the candidate ID.

Input: getRequisitionsRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of candidate

Output: getRequisitionsResponse

Data Field Name Data Field Type Required Acceptable Values


getRequisitionsReturn array of requisition IDs

getRequisitions Test Case:

Input: getRequisitionsRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getRequisitions>
<in0>webapi-8638387102069848283</in0>
<in1>48</in1>
</urn:getRequisitions>
</soapenv:Body>
</soapenv:Envelope>

Output: getRequisitionsResponse

Taleo Business Edition API Guide Page 70


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getRequisitionsResponse xmlns="urn:TBEWebAPI">
<getRequisitionsReturn xmlns="">
<array>
<item>15</item>
<item>13</item>
</array>
</getRequisitionsReturn>
</getRequisitionsResponse>
</soapenv:Body>
</soapenv:Envelope>

searchCandidate Element:

Operation type: Request-response.


 The endpoint receives a message to query all candidates based on defined key (field
name) and value (data looking for), and sends a correlated message of Candidate ID and
associated search relevance.
 Relevance is a value between 0 and 100, which reflects how well the account matches
the search criteria
 Map of search parameters always contains:
o key: name of field to search as a string
o value: search parameter as string.
 Format of search value may differ depending on data type of the search field:
 For text, text area, email, URL fields: simple text to be found (case-insensitive) in this
field. Example:
o key=”city”, value=”Francisco” will search for all candidates with ”Francisco” in
“city” field.
 For integer, double, currency: interval between two numbers separated by ‘|’ character.
Either left (from) or right (to) side can be omitted. Example:
o key=”rank”, value=”100|” will search for all candidates with rank value no less
than 100.
o key=”rank”, value=”|200” will search for all candidates with rank value no more
than 200.
o key=”rank”, value=”100|200” will search for all candidates with rank value
between 100 and 200 (inclusive).
 For date fields: interval between two dates in ISO yyyy-MM-dd format, separated by ‘|’
character. Either left (from) or right (to) side can be omitted. Example:

Taleo Business Edition API Guide Page 71


Candidate API Calls
getCandidateById Element:

o key=”startDate”, value=”2004-06-01|” will search for all candidates with start


date on or after June 1st 2004.
o key=”startDate”, value=”|2004-08-01” will search for all candidates with start
date on or before August 1st 2004.
o key=”startDate”, value=”2004-06-01|2004-08-01” will search for all candidates
with start date between June 1st 2004 and August 1st 2004 (inclusive).
 For date interval fields: number of days from today to the past. Example:
o key=” addedWithin”, value=”7” will search for all candidates added to the
system within the last week.
 For single pick list: code value or name of selected item. Example:
o key=”country”, value=”US” will search for all candidates with country field equals
to “United States”.
o key=”status”, value=”available” will search for all candidates in “Available” status.
 For multiple pick list: code values or names of selected items, separated by ‘|’ character.
Example:
o key=”customMultiple”, value=”A1|B2|X5” will search for all candidates with
customMultiple field containing one or more of values: A1, B2, X5.
 For check box fields: “true” if check box must be checked, “false” is unchecked. Example:
o key=” flagged”, value=”true” will search for all candidates “flagged” for the user
currently logged in.
 Search keys names and types can be found in Administration>Customize>Candidate
Fields. They may include both system fields (listed below for convenience) and custom
fields. For custom fields External name is used as key name.

System Search Keys:

Data Field Name Parameter Type Description


Keyword(s) in candidate’s resume.
keyword String Identical syntax as used in Taleo browser
interface
candid Integer ID of candidate
firstName String First name
lastName String Last name
middleInitial String Middle name
address String Street address
city String City
state Pick list State/Region
zipCode String ZIP/Postal code
country Pick list Country name
phone String Phone #
cellPhone String Mobile #
phoneAll String Any phone

Taleo Business Edition API Guide Page 72


Candidate API Calls
getCandidateById Element:

email String Email


legalStatus
Pick list Legal status

status
Pick list Status name

source
Pick list Source name

lastUpdated
Date Last updated date

creationDate
Date Added to system date

gender
Pick list Gender

race
Pick list Race name

veteran
Pick list Veteran/Disability

rank
Integer Rank (%)

referredBy
String Referred By

requisitions Ids of requisitions (‘|’ – separated) this


Custom
candidate is submitted to
addedWithin
Integer Added within N days

updatedWithin
Integer Updated within N days

flagged
Check Box Flagged candidates only

ReasonRej
Pick list Reason for rejection

hiredDate
Date Hired date

Taleo Business Edition API Guide Page 73


Candidate API Calls
getCandidateById Element:

startDate Date Start date


intStatus
String Supported value: “hired”

Input: searchCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
key
in1 Item… Yes
value

Output: searchCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


searchCandidateReturn searchResultBean []

searchCandidate Test Case:

Input: searchCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:searchCandidate>
<in0>webapi-1081039353966410322</in0>
<in1>
<!--Zero or more repetitions:-->
<item>
<key>country</key>
<value>Canada</value>
</item>
</in1>
</urn:searchCandidate>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 74


Candidate API Calls
getCandidateById Element:

Output: searchCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<searchCandidateResponse xmlns="urn:TBEWebAPI">
<searchCandidateReturn xmlns="">
<array>
<item>
<id>30</id>
<relevance>1.0</relevance>
</item>
<item>
<id>48</id>
<relevance>1.0</relevance>
</item>
</array>
</searchCandidateReturn>
</searchCandidateResponse>
</soapenv:Body>
</soapenv:Envelope>

submitCandidate Element:

Operation type: Request-response.


 The endpoint receives a message to submit a candidate to a requisition(s), and sends a
correlated message only if error occured.
 Please Note: Submit requests replace all previous requisitions that the candidate has
been tied too previously (i.e. data is not appended or upserted). Send all previous
requisitions back if simply adding an additional requisition or use
upsertCandidateToRequisitions call.

Input: submitCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login

Taleo Business Edition API Guide Page 75


Candidate API Calls
getCandidateById Element:

in1 Long Yes ID of Candidate


in2
Array of requisition
Long Yes
IDs

Output: submitCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


submitCandidateReturn

submitCandidate Test Case:

Input: submitCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:submitCandidate>
<in0>webapi-1081039353966410322</in0>
<in1>48</in1>
<in2>
<array>
<!--Zero or more repetitions:-->
<item>15</item>
</array>
</in2>
</urn:submitCandidate>
</soapenv:Body>
</soapenv:Envelope>

Output: submitCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<submitCandidateResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 76


Candidate API Calls
getCandidateById Element:

removeCandidate Element:

Operation type: Request-response.


 The endpoint receives a message to remove an existing candidate assignment from a
requisition (both based on ID variables), and sends a correlated message only if error
occurred.

Input: removeCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes Candidate ID
in2 Long Yes Requisition ID

Output: removeCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


removeCandidateReturn

removeCandidate Test Case:

Input: removeCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:removeCandidate>
<in0>webapi-3736131371583618769</in0>
<in1>48</in1>
<in2>15</in2>
</urn:removeCandidate>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 77


Candidate API Calls
getCandidateById Element:

Output: removeCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<removeCandidateResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

updateCandidate Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing candidate, and sends a correlated
message only if error occurred.
 Please Note: Update requests replace all data fields in the candidateBean (i.e. data is not
appended or upserted). Send all elements back or the field values will be returned NULL.

Input:updateCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 candidateBean[] * flexValues []
id
status *
address
cellPhone
city
country
email *
firstName
gender
hiredDate
lastName *
legalStatus
middleInitial
password
phone
race
rank

Taleo Business Edition API Guide Page 78


Candidate API Calls
getCandidateById Element:

reasonRejected
referredBy
resumeFileName
source
startDate
state
submittedBy
textResume
veteren
zipCode

Output: updateCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


updateCandidateReturn

updateCandidate Test Case:

Input: updateCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateCandidate>
<in0>webapi6675924402134546238</in0>
<in1>
<flexValues>
<!--Zero or more repetitions :-->
</flexValues>
<Id>48</Id>
<status>Hired</status>
<address>2323 Macaroni Road</address>
<cellPhone>999-343-2344</cellPhone>
<city>Jason</city>
<country>US-CA</country>
<email>[email protected]</email>
<firstName>Jessica</firstName>
<gender>Choose Not to Disclose</gender>
<hiredDate>2009-09-04T18:33:50.830Z</hiredDate>
<lastName>Karim</lastName>
<legalStatus>My status to work in this country is unknown</legalStatus>

Taleo Business Edition API Guide Page 79


Candidate API Calls
getCandidateById Element:

<middleInitial>H</middleInitial>
<password>jason</password>
<cellPhone>892-232-2334</cellPhone>
<phone>748-232-2323</phone>
<race>Hispanic or Latino</race>
<rank>100</rank>
<reasonRejected>Position was canceled</reasonRejected>
<referredBy>skarim</referredBy>
<source>Other</source>
<startDate>2009-09-04T18:33:50.830Z</startDate>
<state>US-CA</state>
<submittedBy>skarim</submittedBy>
<textResume>Skilled in after school specials</textResume>
<veteran>Armed Forces Service Medal Veterans</veteran>
<zipCode>93045</zipCode>
</in1>
</urn:createCandidate>
</soapenv:Body>
</soapenv:Envelope>

Output: updateCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateCandidateResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

upsertCandidateToRequisitions Element:

Operation type: Request-response.


 The endpoint receives a message to upsert, or append a candidate to a requisition, and
sends a correlated message only if error occured.
 Please Note: Definition of client-side statusIDs and reasonIDs will be needed when
passing these attributes (descriptive text is not supported).
 Please Note: ReasonIDs are required when a ‘Rejected’ Status ID has been selected.

Taleo Business Edition API Guide Page 80


Candidate API Calls
getCandidateById Element:

 Please Note: doRanking element is Boolean True/False, which forces the system to
recalculate the candidate’s rank for that requisition on upsert.

 Please Note: As each client may be able to customize status and reasons, a standard list
of ID’s has not been provided. The easiest way to find a client’s status and reason IDs is
to go into the application and:
o Select a candidate
o Attach the candidate to any requisition at the top of the screen
o Select ‘Rejected’ under the ‘Requisition-specific status:’ picklist
o When the ‘Requisition-specific reason for rejection:’ picklist appears, right click
the page and select ‘View Source’.
o From here you will find a list of appropriate ID values for both sources (sourceID)
and reasons (reasonID).

Taleo Business Edition API Guide Page 81


Candidate API Calls
getCandidateById Element:

Input: upsertCandidateToRequisitionsRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionId String Yes
Login
candidateId Long Yes ID of Candidate
Array of requisition
requistionIds LongArr Yes
IDs
ID of status or
statusId Long Yes requisition-specific
status ID
ID of reasonRej or
Yes if statusID =
reasonId Long requisition rejected
“Rejected”
status ID
True
doRanking Boolean No
False

Output: upsertCandidateToRequisitionsResponse

Data Field Name Data Field Type Required Acceptable Values


upsertCandidateToRequisitionsReturn

upsertCandidateToRequisitions Test Case:

Input: upsertCandidateToRequisitionsRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:upsertCandidateToRequisitions>
<sessionId>webapi-1081039353966410322</sessionId>
<candidateId>48</candidateId>
<requisitionIds>
<array>
<!--Zero or more repetitions:-->
<item>15</item>
</array>
</requisitionIds>
<statusId>14</statusId>
<reasonId>476</reasonId>

Taleo Business Edition API Guide Page 82


Candidate API Calls
getCandidateById Element:

<doRanking>True</doRanking>
</urn:upsertCandidateToRequisitions>
</soapenv:Body>
</soapenv:Envelope>

Output: upsertCandidateToRequisitionsResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<upsertCandidateToRequisitionsResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Candidate Rolling Entity Calls


A new feature within Taleo Business Edition is the addition of dynamic data forms, or what we
call rolling entities. Rolling Entities are any commonly collected and presented data set that has a
many-to-one relationship to a candidate. An existing example of Rolling Entities is Work History,
whereby the same fielded information is collected on each of the candidate’s previous
employers and positions. Rolling Entities allow for flexibility in the collection of data. By
extending this functionality, you can now collect multiples sets of data related to:

 Education History
 Licenses & Certifications
 Previous Residences
 References
 Work History

rollingEntityBean Definition:

Data Field Name Data Field Type Required Acceptable Values


Contact’s unique server
side ID. Can be obtained
by searching the
ID Long Read Only
accounts’ database or
by creating a new
account.

Taleo Business Edition API Guide Page 83


Candidate API Calls
getCandidateById Element:

sessionID String Yes Session ID received at


Login
status
Rolling Entity Status
Long Yes
from pick list
WORK_HISTORY
RESIDENCE_HISTORY
rollingEntityType String Yes EDUCATION
REFERENCES
CERTIFICATES_LICENCES
entityType Yes
String CAND
entityID Long Yes Candidate ID
creationDate Date Read Only Creation date

lastUpdated Date Read Only Last updated date

attributes AttributeBean No Array of rolling entity


attribute (standard)
field values
flexValues FlexFieldBean[] No Array of flexible
(custom) field values

attributeBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue Boolean No Value of Check Box field
DateValue Date No Value of Date field

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name

Taleo Business Edition API Guide Page 84


Candidate API Calls
getCandidateById Element:

FieldName String Yes Field name


StringValue
Value of Text, Email, URL, Pick list, or Text
String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue Boolean No Value of Check Box field
DateValue Date No Value of Date field

deleteRollingEntity Element:

Operation type: Request-response.


 The endpoint receives a message to delete a specific rolling entity instance based on ID,
and sends a correlated message only if error occured.

Input: deleteRollingEntityRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
rollingEntityId String Yes ID of rolling entity

Output: deleteRollingEntityResponse

Data Field Name Data Field Type Required Acceptable Values


deleteRollingEntityReturn

deleteRollingEntity Test Case:

Input: deleteRollingEntityRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteRollingEntity>
<sessionId>webapi-3736131371583618769</sessionId>
<rollingEntityId>11</rollingEntityId>
</urn:deleteRollingEntity>

Taleo Business Edition API Guide Page 85


Candidate API Calls
getCandidateById Element:

</soapenv:Body>
</soapenv:Envelope>

Output: deleteRollingEntityResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteRollingEntityResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getRollingEntities Element:

Operation type: Request-response.


 The endpoint receives a message to get a specific rolling entity for a candidate, and
sends a correlated message of rolling entity information.
 Please Note, only candidate rolling entities are supported currently.
 The response will be empty if no entities are filled in, otherwise the standard Taleo
Business Edition API error code will return.
 There is no ‘ALL’ function; a call is configured for the pulling of each rolling entity type:
o WORK_HISTORY
o RESIDENCE_HISTORY
o EDUCATION
o REFERENCES
o CERTIFICATES_LICENCES

Input: getRollingEntitiesRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
WORK_HISTORY
RESIDENCE_HISTORY
rollingEntityType String Yes EDUCATION
REFERENCES
CERTIFICATES_LICENCES

Taleo Business Edition API Guide Page 86


Candidate API Calls
getCandidateById Element:

entityType String Yes CAND


entityID Yes
Long Candidate ID

Output: getRollingEntitiesResponse

Data Field Name Data Field Type Required Acceptable Values


getRollingEntitiesReturn rollingEntitiesBean []

getRollingEntities Test Case:

Input: getRollingEntitiesRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getRollingEntities>
<sessionId>webapi-6894240122814704138</sessionId>
<rollingEntityType>WORK_HISTORY</rollingEntityType>
<entityType>CAND</entityType>
<entityId>45</entityId>
</urn:getRollingEntities>
</soapenv:Body>
</soapenv:Envelope>

Output: getRollingEntitiesResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getRollingEntitiesResponse xmlns="urn:TBEWebAPI">
<getRollingEntitiesReturn xmlns="">
<array>
<item>
<creationDate>2009-08-11T15:43:45.273Z</creationDate>
<flexValues>
<item>

Taleo Business Edition API Guide Page 87


Candidate API Calls
getCandidateById Element:

<fieldName>Starting Rate Of Pay</fieldName>


<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>56000</valueStr>
</item>
</flexValues>
<id>13</id>
<lastUpdated>2009-08-15T00:13:33.283Z</lastUpdated>
<status xsi:nil="true"/>
<attributes>
<item>
<fieldName>workHistJobTitle</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>Lovely Manager</valueStr>
</item>
<item>
<fieldName>workHistFrom</fieldName>
<valueBool xsi:nil="true"/>
<valueDate>2007-02-01T00:00:00.000Z</valueDate>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
<item>
<fieldName>workHistDesc</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>Was a lovely manager</valueStr>
</item>
<item>
<fieldName>workHistCoName</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>

Taleo Business Edition API Guide Page 88


Candidate API Calls
getCandidateById Element:

<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>McKesson</valueStr>
</item>
<item>
<fieldName>workHistStreet</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>12 – Richmond Street</valueStr>
</item>
<item>
<fieldName>workHistCityState</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>BC</valueStr>
</item>
<item>
<fieldName>workHistPhone</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>858-304-3434</valueStr>
</item>
<item>
<fieldName>workHistSupervisor</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>595-394-4094</valueStr>
</item>
<item>
<fieldName>workHistSuperTitle</fieldName>
<valueBool xsi:nil="true"/>

Taleo Business Edition API Guide Page 89


Candidate API Calls
getCandidateById Element:

<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>Manager</valueStr>
</item>
<item>
<fieldName>workHistOkContact</fieldName>
<valueBool>true</valueBool>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
<item>
<fieldName>workHistPay</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>65000</valueStr>
</item>
<item>
<fieldName>toPresent</fieldName>
<valueBool>true</valueBool>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
</attributes>
<entityType>CAND</entityType>
<entityId>45</entityId>
<subType>WORK_HISTORY</subType>
</item>
</array>
</getRollingEntitiesReturn>
</getRollingEntitiesResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 90


Candidate API Calls
getCandidateById Element:

upsertRollingEntity Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing rolling entity instance, and sends
a correlated message only if error occurred.
 Please Note: Upsert is used to both create or update data within a specific rolling entity.
Using the ID attribute updates or replaces existing rolling entity instance, whereas not
using an entityId will create a new rolling entity for the entity ID.

Input: upsertRollingEntityRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
flexValues []
attributes []
id *
rollingEntityBean rollingEntityBean [] * status *
entityId
entityType
subType

Output: upsertRollingEntityResponse

Data Field Name Data Field Type Required Acceptable Values


upsertRollingEntityReturn

upsertRollingEntity Test Case:

Input: upsertRollingEntityRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:upsertRollingEntity>
<sessionId>webapi-3736131371583618769</sessionId>
<rollingEntityBean>
<flexValues>
<!--Zero or more repetitions:-->

Taleo Business Edition API Guide Page 91


Candidate API Calls
getCandidateById Element:

</flexValues>
<id>12</id>
<status>New</status>
<attributes>
<!--Zero or more repetitions:-->
<item>
<fieldName>workHistJobTitle</fieldName>
<valueStr>Senior Recruiter</valueStr>
</item>
<item>
<fieldName>workHistOkContact</fieldName>
<valueBool>False</valueBool>
</item>
</attributes>
<entityType>CAND</entityType>
<entityId>44</entityId>
<subType>WORK_HISTORY</subType>
</rollingEntityBean>
</urn:upsertRollingEntity>
</soapenv:Body>
</soapenv:Envelope>

Output: upsertRollingEntityResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
< upsertRollingEntityResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Contact API Calls


Contacts are all of the individuals associated with your Accounts that you need to track in Taleo
Business Edition.

contactBean Definition:

Taleo Business Edition API Guide Page 92


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


Contact’s unique
server side ID. Can be
obtained by searching
ID Long Read Only the accounts’
database or by
creating a new
account.
status String Yes Contact’s Status from
pick list

firstName String No Contact’s first name

lastName String Yes Contact’s first name

accounted long No ID of parent account

title String No Contact’s title

department String No Contact’s department

reportsToId long No ID of parent contact

phone String No Phone number

cellPhone String No Cell phone number

fax String No Fax number

email String No Email address

assistantName String No Assistant’s name

assistantPhone String No Assistant’s phone

assistantEmail String No Assistant’s email

Taleo Business Edition API Guide Page 93


Candidate API Calls
getCandidateById Element:

address String No Street portion of


mailing address
city String No City name

zipCode String No ZIP or postal code


state String No State, region or
province name from
pick list
country String No Country code from
pick list
description String No Contact’s description
creationDate Date Read Only Creation date
lastUpdated Date Read Only Last updated date
flexValues FlexFieldBean[] No Array of flexible
(custom) field values

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue Boolean No Value of Check Box field
DateValue Date No Value of Date field

createContact Element:

Operation type: Request-response.


 The endpoint receives a message to create a contact, and sends a correlated message of
contact ID.
 Using accountID element allows the contact to be tied to a specific Account.

Input:createContactRequest

Taleo Business Edition API Guide Page 94


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
status
accountId
address
assistantEmail
assistantName
assistantPhone
cellPhone
city
contactType
country
in1 contactBean[] *
department
description
email
fax
firstName
lastName *
phone
reportsToId
state
title
zipCode

Output: createContactResponse

Data Field Name Data Field Type Required Acceptable Values


createContactReturn Long Yes Provided Contact ID

createContact Test Case:

Input: createContactRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createContact>

Taleo Business Edition API Guide Page 95


Candidate API Calls
getCandidateById Element:

<in0>webapi6675924402134546238</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<accountId>2</accountId>
<address>82 Taleo Drive</address>
<assistantEmail>[email protected]</assistantEmail>
<assistantName>Shakir Karim</assistantName>
<assistantPhone>604-761-0087</assistantPhone>
<cellPhone>604-920-3949</cellPhone>
<city>Dublin</city>
<contactType>?</contactType>
<country>United States</country>
<department>Sales</department>
<description>Head of Partners and Alliances</description>
<email>[email protected]</email>
<fax>604-323-2323</fax>
<firstName>Don</firstName>
<lastName>Darrah</lastName>
<phone>583-903-3434</phone>
<state>US-CA</state>
<title>Manager</title>
<zipCode>90210</zipCode>
</in1>
</urn:createContact>
</soapenv:Body>
</soapenv:Envelope>

Output: createContactResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createContactResponse xmlns="urn:TBEWebAPI">
<createContactReturn xmlns="">1</createContactReturn>
</createContactResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 96


Candidate API Calls
getCandidateById Element:

deleteContact Element:

Operation type: Request-response.


 The endpoint receives a message to delete a contact, and sends a correlated message
only if error occurred.

Input: deleteContactRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Contact ID Yes ID of Contact

Output: deleteContactResponse

Data Field Name Data Field Type Required Acceptable Values


deleteContactReturn

deleteContact Test Case:

Input: deleteContactRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteContact>
<in0>webapi6675924402134546238</in0>
<in1>1</in1>
</urn:deleteContact>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteContactResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteContactResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>

Taleo Business Edition API Guide Page 97


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

getContactById Element:

Operation type: Request-response.


 The endpoint receives a message to get a contact details, and sends a correlated
message of Contact information.

Input: getContactByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Contact ID Yes ID of Contact

Output: getContactByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getContactByIdReturn contactBean []

getContactById Test Case:

Input: getContactByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getContactById>
<in0>webapi6675924402134546238</in0>
<in1>1</in1>
</urn:getContactById>
</soapenv:Body>
</soapenv:Envelope>

Output: getContactByIdResponse

Taleo Business Edition API Guide Page 98


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getContactByIdResponse xmlns="urn:TBEWebAPI">
<getContactByIdReturn xmlns="">
<creationDate>2009-08-21T22:04:14.597Z</creationDate>
<flexValues/>
<id>1</id>
<lastUpdated>2009-08-21T22:09:35.259Z</lastUpdated>
<status xsi:nil="true"/>
<accountId>2</accountId>
<address>82 Taleo Drive</address>
<assistantEmail>[email protected]</assistantEmail>
<assistantName>Sonia Jason</assistantName>
<assistantPhone>604-894-9487</assistantPhone>
<cellPhone>604-920-3949</cellPhone>
<city>Dublin</city>
<contactType xsi:nil="true"/>
<country>United States</country>
<creator xsi:nil="true"/>
<department>Sales</department>
<description>Head of Partners and Alliances</description>
<email>[email protected]</email>
<fax>604-323-2323</fax>
<firstName>Don</firstName>
<lastName>Darrah</lastName>
<phone>583-903-3434</phone>
<reportsToId>0</reportsToId>
<state>US-CA</state>
<title>Manager</title>
<zipCode>90210</zipCode>
</getContactByIdReturn>
</getContactByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

getContactHistory Element:

Operation type: Request-response.


 The endpoint receives a message to get a Contact transaction history, and sends a
correlated message of transaction history for contact information.

Taleo Business Edition API Guide Page 99


Candidate API Calls
getCandidateById Element:

 This object is used to fetch a history log entry which reflects a past event or action
related to contacts. History records can only be created by the server, they cannot be
modified or deleted. History log includes server side ID, test describing history record,
complete text of email message (for email events) and creation date.

Input: getContactHistoryRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Contact ID Yes ID of Contact

Output: getContactHistoryResponse

Data Field Name Data Field Type Required Acceptable Values


getContactHistoryReturn historyBean []

getContactHistory Test Case:

Input: getContactHistoryRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getContactHistory>
<in0>webapi-2722388699079508905</in0>
<in1>2</in1>
</urn:getContactHistory>
</soapenv:Body>
</soapenv:Envelope>

Output: getContactHistoryResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>

Taleo Business Edition API Guide Page 100


Candidate API Calls
getCandidateById Element:

<getContactHistoryResponse xmlns="urn:TBEWebAPI">
<getContactHistoryReturn xmlns="">
<array>
<item>
<creationDate>2009-08-21T22:28:05.247Z</creationDate>
<emailText xsi:nil="true"/>
<id>508</id>
<text>Contact created</text>
<userName>skarim</userName>
</item>
</array>
</getContactHistoryReturn>
</getContactHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>

searchContact Element:

Operation type: Request-response.


 The endpoint receives a message to query all contacts based on defined key (field name)
and value (data looking for), and sends a correlated message of Contact ID and
associated search relevance.
 Relevance is a value between 0 and 100, which reflects how well the account matches
the search criteria
 Map of search parameters always contains:
o key: name of field to search as a string
o value: search parameter as string.
 Format of search value may differ depending on data type of the search field:
 For text, text area, email, URL fields: simple text to be found (case-insensitive) in this
field. Example:
o key=”city”, value=”Francisco” will search for all candidates with ”Francisco” in
“city” field.
 For integer, double, currency: interval between two numbers separated by ‘|’ character.
Either left (from) or right (to) side can be omitted. Example:
o key=”rank”, value=”100|” will search for all candidates with rank value no less
than 100.
o key=”rank”, value=”|200” will search for all candidates with rank value no more
than 200.

Taleo Business Edition API Guide Page 101


Candidate API Calls
getCandidateById Element:

okey=”rank”, value=”100|200” will search for all candidates with rank value
between 100 and 200 (inclusive).
 For date fields: interval between two dates in ISO yyyy-MM-dd format, separated by ‘|’
character. Either left (from) or right (to) side can be omitted. Example:
o key=”startDate”, value=”2004-06-01|” will search for all candidates with start
date on or after June 1st 2004.
o key=”startDate”, value=”|2004-08-01” will search for all candidates with start
date on or before August 1st 2004.
o key=”startDate”, value=”2004-06-01|2004-08-01” will search for all candidates
with start date between June 1st 2004 and August 1st 2004 (inclusive).
 For date interval fields: number of days from today to the past. Example:
o key=” addedWithin”, value=”7” will search for all candidates added to the
system within the last week.
 For single pick list: code value or name of selected item. Example:
o key=”country”, value=”US” will search for all candidates with country field equals
to “United States”.
o key=”status”, value=”available” will search for all candidates in “Available” status.
 For multiple pick list: code values or names of selected items, separated by ‘|’ character.
Example:
o key=”customMultiple”, value=”A1|B2|X5” will search for all candidates with
customMultiple field containing one or more of values: A1, B2, X5.
 For check box fields: “true” if check box must be checked, “false” is unchecked. Example:
o key=” flagged”, value=”true” will search for all candidates “flagged” for the user
currently logged in.
 Search keys names and types can be found in Administration>Customize>Contact Fields.
They may include both system fields (listed below for convenience) and custom fields.
For custom fields External name is used as key name.

System Search Keys:

Data Field Name Parameter Type Description


Keyword(s) in contact’s description.
keyword String Identical syntax as used in Taleo browser
interface.
firstName String Contact’s first name
lastName String Contact’s last name
accountId String ID of parent account
title String Contact’s title
department String Department
reportsToId String ID of parent contact
phoneAll String Any contact’s phone number
email String Email address

Taleo Business Edition API Guide Page 102


Candidate API Calls
getCandidateById Element:

city Pick list City name


state
State, region or province name from pick
String
list

country
String Country code from pick list

addedWithin
Integer Added within N days

updatedWithin
Integer Updated within N days

Input: searchContactRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
key
in1 Item… Yes
value

Output: searchContactResponse

Data Field Name Data Field Type Required Acceptable Values


searchContactReturn searchResultBean []

searchContact Test Case:

Input: searchContactRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:searchContact>
<in0>webapi6675924402134546238</in0>
<in1>

Taleo Business Edition API Guide Page 103


Candidate API Calls
getCandidateById Element:

<!--Zero or more repetitions:-->


<item>
<key>description</key>
<value>Partners</value>
</item>
</in1>
</urn:searchContact>
</soapenv:Body>
</soapenv:Envelope>

Output: searchContactResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<searchContactResponse xmlns="urn:TBEWebAPI">
<searchContactReturn xmlns="">
<array>
<item>
<id>1</id>
<relevance>1.0</relevance>
</item>
</array>
</searchContactReturn>
</searchContactResponse>
</soapenv:Body>
</soapenv:Envelope>

updateContact Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing contact, and sends a correlated
message only if error occurred.
 Please Note: Update requests replace all data fields in the contactBean (i.e. data is not
appended or upserted). Send all elements back or the field values will be returned NULL.

Input:updateContactRequest

Data Field Name Data Field Type Required Acceptable Values

Taleo Business Edition API Guide Page 104


Candidate API Calls
getCandidateById Element:

in0 String Yes Session ID received at


Login
flexValues []
status
accountId *
address
assistantEmail
assistantName
assistantPhone
cellPhone
city
contactType
country
in1 contactBean[] *
department
description
email
fax
firstName
lastName *
phone
reportsToId
state
title
zipCode

Output: updateContactResponse

Data Field Name Data Field Type Required Acceptable Values


updateContactReturn

updateContact Test Case:

Input: updateContactRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateContact>
<in0>webapi6675924402134546238</in0>
<in1>
<flexValues>

Taleo Business Edition API Guide Page 105


Candidate API Calls
getCandidateById Element:

<!--Zero or more repetitions :-->


</flexValues>
<accountId>2</accountId>
<address>82 Taleo Drive</address>
<assistantEmail>[email protected]</assistantEmail>
<assistantName>Sonia Jason</assistantName>
<assistantPhone>604-894-9487</assistantPhone>
<cellPhone>604-920-3949</cellPhone>
<city>Dublin</city>
<contactType>?</contactType>
<country>United States</country>
<department>Sales</department>
<description>Head of Partners and Alliances</description>
<email>[email protected]</email>
<fax>604-323-2323</fax>
<firstName>Don</firstName>
<lastName>Darrah</lastName>
<phone>583-903-3434</phone>
<state>US-CA</state>
<title>Manager</title>
<zipCode>90210</zipCode>
</in1>
</urn:updateContact>
</soapenv:Body>
</soapenv:Envelope>

Output: updateContactResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateContactResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Contact Log API Calls


Contact logs are a running trail of communication stored within a specific entity of Taleo
Business Edition. There is a one-to-many relationship with contact logs to entities. Entities

Taleo Business Edition API Guide Page 106


Candidate API Calls
getCandidateById Element:

include accounts (ACCT), candidates (CAND), contacts (CTCT), employees (EMPL), requisitions
(REQU) and users (WORK).

contactLogBean Definition:

Data Field
Data Field Name Required Acceptable Values
Type
id long Read Only Contact log’s unique server side ID.
creator String Login name of user who has created this
Yes
record
typeNo int Type of contact log:
1 = email
Yes
2 = phone call
3 = response
entityType String Type of related entity:
ACCT = accounts
CAND = candidates
Yes CTCT = contacts
EMPL = employees
REQU = requisitions
WORK = users
entityId long Yes ID of related entity
subject String Yes Log’s subject
comments String No Log’s comments or email body
contactDate Date No Contact date
creationDate Date Read Only Creation date
lastUpdated Date Read Only Last updated date

createContactLog Element:

Operation type: Request-response.


 The endpoint receives a message to create a contact log, and sends a correlated
message of contact log ID.

Input: createContactLogRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login

Taleo Business Edition API Guide Page 107


Candidate API Calls
getCandidateById Element:

in1 contactLogBean[] * creator *


typeNo *
entityType *
entityId *
subject *
comments
contactDate

Output: createContactLogResponse

Data Field Name Data Field Type Required Acceptable Values


Provided Contact Log
createContactLogReturn Long Yes
ID

createContactLog Test Case:

Input: createreateContactLogRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createContactLog>
<in0>webapi-1081039353966410322</in0>
<in1>
<comments>Unable to Get a Hold of Candidate</comments>
<contactDate>2009-06-30T23:01:26.493Z</contactDate>
<creator>skarim</creator>
<entityId>48</entityId>
<entityType>CAND</entityType>
<subject>Phone Screen</subject>
<typeNo>2</typeNo>
</in1>
</urn:createContactLog>
</soapenv:Body>
</soapenv:Envelope>

Output: createContactLogResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

Taleo Business Edition API Guide Page 108


Candidate API Calls
getCandidateById Element:

<soapenv:Body>
<createContactLogResponse xmlns="urn:TBEWebAPI">
<createContactLogReturn xmlns="">3</createContactLogReturn>
</createContactLogResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteContactLog Element:

Operation type: Request-response.


 The endpoint receives a message to delete a contact log, and sends a correlated
message only if error occurred.

Input: deleteContactLogRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Contact Log ID Yes ID of Contact Log

Output: deleteContactLogResponse

Data Field Name Data Field Type Required Acceptable Values


deleteContactLogReturn

deleteContactLog Test Case:

Input: deleteContactLogRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteContactLog>
<in0>webapi-6706128845720983299</in0>
<in1>6</in1>
</urn:deleteContactLog>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 109


Candidate API Calls
getCandidateById Element:

Output: deleteContactLogResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteContactLogResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getContactLogById Element:

Operation type: Request-response.


 The endpoint receives a message to get a contact log details by contact log ID, and sends
a correlated message of contact log information.

Input: getContactLogByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Contact Log ID Yes ID of Contact Log

Output: getContactLogByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getContactLogByIdReturn contactLogBean []

getContactLogById Test Case:

Input: getContactLogByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getContactLogById>
<in0>webapi-6706128845720983299</in0>

Taleo Business Edition API Guide Page 110


Candidate API Calls
getCandidateById Element:

<in1>6</in1>
</urn:getContactLogById>
</soapenv:Body>
</soapenv:Envelope>

Output: getContactLogByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getContactLogByIdResponse xmlns="urn:TBEWebAPI">
<getContactLogByIdReturn xmlns="">
<comments>Informed candidate that requisition has been closed.</comments>
<contactDate>2009-09-11T00:00:00.000Z</contactDate>
<creationDate>2009-09-11T05:45:08.260Z</creationDate>
<creator>super-admin</creator>
<entityId>48</entityId>
<entityType>CAND</entityType>
<id>6</id>
<lastUpdated>2009-09-11T05:45:08.260Z</lastUpdated>
<subject>Requisition Closed</subject>
<typeNo>2</typeNo>
</getContactLogByIdReturn>
</getContactLogByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

getContactLogsByEntity Element:

Operation type: Request-response.


 The endpoint receives a message to get contact log(s) associated with any Taleo Business
Edition entity that supports storing of contact logs, and sends back contact log IDs
associated with the entity ID.

Input: getContactLogsByEntity Request

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes Type of related entity:

Taleo Business Edition API Guide Page 111


Candidate API Calls
getCandidateById Element:

ACCT = accounts
CAND = candidates
EMPL = employees
REQU = requisitions
WORK = users
in2
Long Yes ID of associated entity

Output: getContactLogsByEntityResponse

Data Field Name Data Field Type Required Acceptable Values


getContactLogsByEntity
array of contact log IDs
Return

getContactLogsByEntity Test Case:

Input: getContactLogsByEntity Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getContactLogsByEntity>
<in0>webapi-6706128845720983299</in0>
<in1>CAND</in1>
<in2>48</in2>
</urn:getContactLogsByEntity>
</soapenv:Body>
</soapenv:Envelope>

Output: getContactLogsByEntityResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getContactLogsByEntityResponse xmlns="urn:TBEWebAPI">
<getContactLogsByEntityReturn xmlns="">
<array>

Taleo Business Edition API Guide Page 112


Candidate API Calls
getCandidateById Element:

<item>6</item>
<item>4</item>
<item>5</item>
<item>3</item>
</array>
</getContactLogsByEntityReturn>
</getContactLogsByEntityResponse>
</soapenv:Body>
</soapenv:Envelope>

updateContactLog Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing contact log, and sends a
correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the contactLogBean (i.e. data is
not appended or upserted). Send all elements back or the field values will be returned
NULL.

Input: updateContactLogRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
comments
contactDate
creator
entityId *
in1 contactLogBean[] *
entityType *
id *
subject *
typeNo *

Output: updateContactLogResponse

Data Field Name Data Field Type Required Acceptable Values


updateContactLogReturn

updateContactLog Test Case:

Taleo Business Edition API Guide Page 113


Candidate API Calls
getCandidateById Element:

Input: updateContactLogRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateContactLog>
<in0>webapi-6706128845720983299</in0>
<in1>
<comments>Phone Interview was rescheduled</comments>
<contactDate>2009-06-30T23:01:26.493Z</contactDate>
<creator>destey</creator>
<entityId>48</entityId>
<entityType>CAND</entityType>
<id>4</id>
<subject>Interview</subject>
<typeNo>2</typeNo>
</in1>
</urn:updateContactLog>
</soapenv:Body>
</soapenv:Envelope>

Output: updateContactLogResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateContactLogResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Email Log API Calls


Email API calls allow a log to be created in Taleo Business Edition when an email is created
outside of the system. Requires a valid email address stored within the system (i.e. Candidate,
User, Contact). Email API calls provide a contact log ID as a response.

Taleo Business Edition API Guide Page 114


Candidate API Calls
getCandidateById Element:

createEmailLog Element:

Operation type: Request-response.


 The endpoint receives a message to create a contact record that somebody sent an
email to the user (INBOUND EMAIL). Tries to match incoming email address against
candidate, then contact, then user.
 First match is where this contact log gets created within the Session ID (obtained at API
login).

Input:createEmailLogRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
Email address of
candidate, contact, or
in1 String Yes
user (must already
exist)
Subject of email
in2 String Yes
message
Body of email
in3 String Yes
message
Calendar of email
in4 Date Yes
message

Output: createEmailLogResponse

Data Field Name Data Field Type Required Acceptable Values


Provided Contact Log
createEmailLogReturn Long Yes
ID

createEmailLog Test Case:

Input: createEmailLogRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createEmailLog>
<in0>webapi-516132820785594972</in0>
<in1>[email protected]</in1>

Taleo Business Edition API Guide Page 115


Candidate API Calls
getCandidateById Element:

<in2>Test_Subject</in2>
<in3>Test_Body</in3>
<in4>2009-06-30T23:01:26.493Z</in4>
</urn:createEmailLog>
</soapenv:Body>
</soapenv:Envelope>

Output: createEmailLogResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createEmailLogResponse xmlns="urn:TBEWebAPI">
<createEmailLogReturn xmlns="">7</createEmailLogReturn>
</createEmailLogResponse>
</soapenv:Body>
</soapenv:Envelope>

createEmailSentLog Element:

Operation type: Request-response.


 The endpoint receives a message to create a contact record that the user sent somebody
an email (OUTBOUND EMAIL). Tries to match outgoing email address against candidate,
then contact, then user.
 First match is where this contact log gets created within the Session ID (obtained at API
login).

Input:createEmailSentLogRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
Email address of
candidate, contact, or
in1 String Yes
user (must already
exist)
Subject of email
in2 String Yes
message
in3 String Yes Body of email

Taleo Business Edition API Guide Page 116


Candidate API Calls
getCandidateById Element:

message
in4
Calendar of email
Date Yes
message

Output: createEmailSentLogResponse

Data Field Name Data Field Type Required Acceptable Values


Provided Contact Log
createEmailSentLogReturn Long Yes
ID

createEmailSentLog Test Case:

Input: createEmailSentLogRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createEmailSentLog>
<in0>webapi-516132820785594972</in0>
<in1>[email protected]</in1>
<in2>Test_Subject</in2>
<in3>Test_Body</in3>
<in4>2009-06-30T23:01:26.493Z</in4>
</urn:createEmailSentLog>
</soapenv:Body>
</soapenv:Envelope>

Output: createEmailLogResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createEmailSentLogResponse xmlns="urn:TBEWebAPI">
<createEmailSentLogReturn xmlns="">8</createEmailSentLogReturn>
</createEmailSentLogResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 117


Candidate API Calls
getCandidateById Element:

Employee API Calls


Employees are all the people employed by the company and can be managed by Taleo Business
Edition. Employees in the Taleo Business Edition system are uniquely identified by email address.

employeeBean Definition:

Data Field Name Data Field Type Required Acceptable Values


Candidate’s unique
server side ID. Can be
obtained by searching
id Long Read Only the candidate
database or by
creating a new
candidate.
Picklist derived
employee status
(terminated, etc.) . As
these are
status String Yes configurable, view
source on add/edit
employee page to
find values (search for
‘status’)
city String No City name
Street portion of
address String No
address
zipCode String No Zip or postal code
State, region or
state String No province name from
pick list
Country code from
country String No
pick list
Employee telephone
phone String No
number
Configurable
employeeNumber String Yes
employee number
email String No Email of employee
firstName String No First name

Taleo Business Edition API Guide Page 118


Candidate API Calls
getCandidateById Element:

middleInitial String No Middle name


lastName
String Yes Last name

cellPhone
Employees mobile or
String No
cell phone number
hiredDate
Date of which the
dateTime No
employee was hired.
startDate Date of
dateTime No
commencement
race Race name from pick
String No
list
gender Gender name from
String No
pick list
True to lock
employee access
lockedFromEws Boolean No
from the employee
website
Picklist derived
department of
employee . As these
are configurable,
departmentId Long No view source on
add/edit employee
page to find values
(search for
‘department’)
Managers ID that is
managerId Long No the direct superior of
employee
Picklist derived
location of
employee . As these
are configurable,
locationId Long No
view source on
add/edit employee
page to find values
(search for ‘location’)

Taleo Business Edition API Guide Page 119


Candidate API Calls
getCandidateById Element:

ewsLogin String Yes Employee website


login name
ewsPassword
Password chosen on
String Yes
Employee Web Site
jobTitle
String No Employee’s job title

jobCode
Employees defined
String No
job code value
salaryGrade Employees defined
String No
salary grade
salary Employees defined
Double No
salary amount.
Picklist derived
payment frequency
(monthly, etc.) . As
these are
payFrequency String No configurable, view
source on add/edit
employee page to
find values (search for
‘payFrequency’)
Require the
employee to change
their password when
changePswdOnEwsLogin Boolean No
first login to
employee portal
website (EWS)
creationDate
dateTime Read Only Creation date

lastUpdated
dateTime Read Only Last updated date

Array of flexible
(future standard) field
values.
additionalEntities additionalEntitiesBean [] No
** PLACEHOLDER
FOR FUTURE USE
flexValues flexFieldBean [] No Array of flexible

Taleo Business Edition API Guide Page 120


Candidate API Calls
getCandidateById Element:

(custom) field values

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue boolean No Value of Check Box field
DateValue Date No Value of Date field

createEmployee Element:

Operation type: Request-response.


 The endpoint receives a message to create a employee, and sends a correlated message
of employee ID.

Input:createEmployeeRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
bean employeeBean[] * flexValues []
status *
city
address
zipCode
state
country
phone
employeeNumber *
email
firstName
middleInitial
lastName *

Taleo Business Edition API Guide Page 121


Candidate API Calls
getCandidateById Element:

cellPhone
hiredDate
startDate
race
gender
lockedFromEws
reviewManagerId
departmentId
managerId
locationId
ewsLogin *
ewsPassword *
jobTitle
jobCode
salaryGrade
salary
payFrequency
changePswdOnEwsLogin
additionalEntities []

Output: createEmployeeResponse

Data Field Name Data Field Type Required Acceptable Values


createEmployeeReturn Long Yes Provided Employee ID

createEmployee Test Case:

Input:createEmployeeRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createEmployee>
<sessionId>webapi4901801771281067756</sessionId>
<bean>
<flexValues>
<!--Zero or more repetitions:-->
<item>
</item>
</flexValues>
<status>Employed</status>

Taleo Business Edition API Guide Page 122


Candidate API Calls
getCandidateById Element:

<city>Seattle</city>
<address>234 Sandra Ave</address>
<zipCode>578937</zipCode>
<state>US-WA</state>
<country>United States</country>
<phone>754-343-2323</phone>
<employeeNumber>S-54896</employeeNumber>
<email>[email protected]</email>
<firstName>Sharon</firstName>
<middleInitial>A</middleInitial>
<lastName>Darrah</lastName>
<cellPhone>230-234-5895</cellPhone>
<hiredDate>2009-06-30T23:01:26.493Z</hiredDate>
<startDate>2009-10-01T23:01:26.493Z</startDate>
<race>Hispanic or Latino</race>
<gender>Female</gender>
<lockedFromEws>False</lockedFromEws>
<reviewManagerId>4</reviewManagerId>
<departmentId>2</departmentId>
<managerId>4</managerId>
<locationId>2</locationId>
<ewsLogin>sand</ewsLogin>
<ewsPassword>sand</ewsPassword>
<jobTitle>Consultant</jobTitle>
<jobCode>Consulting</jobCode>
<salaryGrade>Level 1</salaryGrade>
<salary>5600</salary>
<payFrequency>Monthly</payFrequency>
<changePswdOnEwsLogin>False</changePswdOnEwsLogin>
<additionalEntities>
<!--Zero or more repetitions:-->
<item>
</item>
</additionalEntities>
</bean>
</urn:createEmployee>
</soapenv:Body>
</soapenv:Envelope>

Output: createEmployeeResponse

Taleo Business Edition API Guide Page 123


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createEmployeeResponse xmlns="urn:TBEWebAPI">
<createEmployeeReturn xmlns="">134</createEmployeeReturn>
</createEmployeeResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteEmployee Element:

Operation type: Request-response.


 The endpoint receives a message to delete an employee, and sends a correlated
message only if error occurred.

Input: deleteEmployeeRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
employeeID Employee ID Yes ID of Employee

Output: deleteEmployeeResponse

Data Field Name Data Field Type Required Acceptable Values


deleteEmployeeReturn

deleteEmployee Test Case:

Input: deleteEmployeeRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteEmployee>
<sessionId>webapi4901801771281067756</sessionId>
<employeeId>134</employeeId>

Taleo Business Edition API Guide Page 124


Candidate API Calls
getCandidateById Element:

</urn:deleteEmployee>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteEmployeeResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteEmployeeResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

deleteEmployeeByNumber Element:

Operation type: Request-response.


 The endpoint receives a message to delete an employee by employee number, and
sends a correlated message only if error occurred.

Input: deleteEmployeeByNumberRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
employeeNumber Employee Number Yes Number of Employee

Output: deleteEmployeeByNumberResponse

Data Field Name Data Field Type Required Acceptable Values


deleteEmployeeByNumberReturn

deleteEmployeeByNumber Test Case:

Input: deleteEmployeeByNumberRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">

Taleo Business Edition API Guide Page 125


Candidate API Calls
getCandidateById Element:

<soapenv:Header/>
<soapenv:Body>
<urn:deleteEmployeeByNumber>
<sessionId>webapi4901801771281067756</sessionId>
<employeeNumber>S-54896</employeeNumber>
</urn:deleteEmployeeByNumber>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteEmployeeByNumberResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteEmployeeByNumberResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getEmployeeById Element:

Operation type: Request-response.


 The endpoint receives a message to get employee general information by ID, and sends
a correlated message of Employee information.

Input: getEmployeeByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
employeeID Employee ID Yes ID of Employee

Output: getEmployeeByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getEmployeeByIdReturn employeeBean []

getEmployeeById Test Case:

Taleo Business Edition API Guide Page 126


Candidate API Calls
getCandidateById Element:

Input: getEmployeeByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getEmployeeById>
<sessionId>webapi4901801771281067756</sessionId>
<employeeId>137</employeeId>
<additionalEntities>
<!--Zero or more repetitions:-->
<item></item>
</additionalEntities>
</urn:getEmployeeById>
</soapenv:Body>
</soapenv:Envelope>

Output: getEmployeeByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getEmployeeByIdResponse xmlns="urn:TBEWebAPI">
<getEmployeeByIdReturn xmlns="">
<creationDate>2009-09-15T17:19:43.153Z</creationDate>
<flexValues>
<item>
<fieldName>District</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
</flexValues>
<id>137</id>
<lastUpdated>2009-09-15T17:19:43.153Z</lastUpdated>
<status>Employed</status>
<city>Seattle</city>
<address>234 Sandra Ave</address>

Taleo Business Edition API Guide Page 127


Candidate API Calls
getCandidateById Element:

<zipCode>578937</zipCode>
<state>US-WA</state>
<country>US</country>
<employeeNumber>S-54896</employeeNumber>
<email>[email protected]</email>
<firstName>Sharon</firstName>
<middleInitial>A</middleInitial>
<lastName>Darrah</lastName>
<cellPhone>230-234-5895</cellPhone>
<title xsi:nil="true"/>
<hiredDate>2009-06-30T23:01:26.493Z</hiredDate>
<startDate>2009-10-01T23:01:26.493Z</startDate>
<race>Hispanic or Latino</race>
<gender>Female</gender>
<reviewManagerId>4</reviewManagerId>
<departmentId>2</departmentId>
<hierarchyPath xsi:nil="true"/>
<managerId>4</managerId>
<locationId>2</locationId>
<ewsLogin>S-54896</ewsLogin>
<ewsPassword>3101290627273108292727644022402228412763==</ewsPassword>
<jobTitle>Consultant</jobTitle>
<jobCode>Consulting</jobCode>
<salaryGrade>Level 1</salaryGrade>
<salary>5600.0</salary>
<payFrequency>Monthly</payFrequency>
<changePswdOnEwsLogin>true</changePswdOnEwsLogin>
<additionalEntities/>
<phone>754-343-2323</phone>
</getEmployeeByIdReturn>
</getEmployeeByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

getEmployeeByNumber Element:

Operation type: Request-response.


 The endpoint receives a message to get employee general information by Number, and
sends a correlated message of Employee information.

Input: getEmployeeByNumberRequest

Taleo Business Edition API Guide Page 128


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
Defined Employee
employeeNumber String Yes
Number

Output: getEmployeeByNumberResponse

Data Field Name Data Field Type Required Acceptable Values


getEmployeeByNumberReturn employeeBean []

getEmployeeByNumber Test Case:

Input: getEmployeeByNumberRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getEmployeeByNumber>
<sessionId>webapi4901801771281067756</sessionId>
<employeeNumber>S-54896</employeeNumber>
<additionalEntities>
<!--Zero or more repetitions:-->
<item></item>
</additionalEntities>
</urn:getEmployeeByNumber>
</soapenv:Body>
</soapenv:Envelope>

Output: getEmployeeByNumberResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getEmployeeByNumberResponse xmlns="urn:TBEWebAPI">
<getEmployeeByNumberReturn xmlns="">
<creationDate>2009-09-15T17:19:43.153Z</creationDate>
<flexValues>

Taleo Business Edition API Guide Page 129


Candidate API Calls
getCandidateById Element:

<item>
<fieldName>District</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
</flexValues>
<id>137</id>
<lastUpdated>2009-09-15T17:19:43.153Z</lastUpdated>
<status>Employed</status>
<city>Seattle</city>
<address>234 Sandra Ave</address>
<zipCode>578937</zipCode>
<state>US-WA</state>
<country>US</country>
<employeeNumber>S-54896</employeeNumber>
<email>[email protected]</email>
<firstName>Sharon</firstName>
<middleInitial>A</middleInitial>
<lastName>Darrah</lastName>
<cellPhone>230-234-5895</cellPhone>
<title xsi:nil="true"/>
<hiredDate>2009-06-30T23:01:26.493Z</hiredDate>
<startDate>2009-10-01T23:01:26.493Z</startDate>
<race>Hispanic or Latino</race>
<gender>Female</gender>
<reviewManagerId>4</reviewManagerId>
<departmentId>2</departmentId>
<hierarchyPath xsi:nil="true"/>
<managerId>4</managerId>
<locationId>2</locationId>
<ewsLogin>S-54896</ewsLogin>
<ewsPassword>3101290627273108292727644022402228412763==</ewsPassword>
<jobTitle>Consultant</jobTitle>
<jobCode>Consulting</jobCode>
<salaryGrade>Level 1</salaryGrade>
<salary>5600.0</salary>
<payFrequency>Monthly</payFrequency>
<changePswdOnEwsLogin>true</changePswdOnEwsLogin>
<additionalEntities/>
<phone>754-343-2323</phone>

Taleo Business Edition API Guide Page 130


Candidate API Calls
getCandidateById Element:

</getEmployeeByNumberReturn>
</getEmployeeByNumberResponse>
</soapenv:Body>
</soapenv:Envelope>

searchEmployee Element:

Operation type: Request-response.


 The endpoint receives a message to query all employees based on defined key (field
name) and value (data looking for), and sends a correlated message of Employee ID and
associated search relevance.
 Relevance is a value between 0 and 100, which reflects how well the account matches
the search criteria
 Map of search parameters always contains:
o key: name of field to search as a string
o value: search parameter as string.
 Format of search value may differ depending on data type of the search field:
 For text, text area, email, URL fields: simple text to be found (case-insensitive) in this
field. Example:
o key=”city”, value=”Francisco” will search for all candidates with ”Francisco” in
“city” field.
 For integer, double, currency: interval between two numbers separated by ‘|’ character.
Either left (from) or right (to) side can be omitted. Example:
o key=”rank”, value=”100|” will search for all candidates with rank value no less
than 100.
o key=”rank”, value=”|200” will search for all candidates with rank value no more
than 200.
o key=”rank”, value=”100|200” will search for all candidates with rank value
between 100 and 200 (inclusive).
 For date fields: interval between two dates in ISO yyyy-MM-dd format, separated by ‘|’
character. Either left (from) or right (to) side can be omitted. Example:
o key=”startDate”, value=”2004-06-01|” will search for all candidates with start
date on or after June 1st 2004.
o key=”startDate”, value=”|2004-08-01” will search for all candidates with start
date on or before August 1st 2004.
o key=”startDate”, value=”2004-06-01|2004-08-01” will search for all candidates
with start date between June 1st 2004 and August 1st 2004 (inclusive).
 For date interval fields: number of days from today to the past. Example:
o key=” addedWithin”, value=”7” will search for all candidates added to the
system within the last week.
 For single pick list: code value or name of selected item. Example:

Taleo Business Edition API Guide Page 131


Candidate API Calls
getCandidateById Element:

o key=”country”, value=”US” will search for all candidates with country field equals
to “United States”.
o key=”status”, value=”available” will search for all candidates in “Available” status.
 For multiple pick list: code values or names of selected items, separated by ‘|’ character.
Example:
o key=”customMultiple”, value=”A1|B2|X5” will search for all candidates with
customMultiple field containing one or more of values: A1, B2, X5.
 For check box fields: “true” if check box must be checked, “false” is unchecked. Example:
o key=” flagged”, value=”true” will search for all candidates “flagged” for the user
currently logged in.
 Search keys names and types can be found in Administration>Customize>Employee
Fields. They may include both system fields (listed below for convenience) and custom
fields. For custom fields External name is used as key name.

System Search Keys:

Data Field Name Parameter Type Description


Keyword(s) in candidate’s resume.
keyword String Identical syntax as used in Taleo browser
interface
emplid Integer ID of candidate
employeeNumber String Configured ID of Employee
jobCode String Job Code Value
firstName String First name
lastName String Last name
middleInitial String Middle name
address String Street address
city String City
state Pick list State/Region
zipCode String ZIP/Postal code
country Pick list Country name
phone String Phone #
cellPhone String Mobile #
phoneAll String Any phone
email String Email
status Pick list Status name
lastUpdated Date Last updated date
creationDate Date Added to system date
gender Pick list Gender
race Pick list Race name
salary Currency salary amount

Taleo Business Edition API Guide Page 132


Candidate API Calls
getCandidateById Element:

salaryGrade Picklist grade of salary payment


addedWithin
Integer Added within N days

updatedWithin
Integer Updated within N days

flagged
Check Box Flagged candidates only

hiredDate
Date Hired date

startDate
Date Start date

Input: searchEmployeeRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
key
searchParams Item… Yes
value

Output: searchEmployeeResponse

Data Field Name Data Field Type Required Acceptable Values


searchEmployeeReturn searchResultBean []

searchEmployee Test Case:

Input: searchEmployeeRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>

Taleo Business Edition API Guide Page 133


Candidate API Calls
getCandidateById Element:

<urn:searchEmployee>
<sessionId>webapi7073868042459393355</sessionId>
<searchParams>
<!--Zero or more repetitions:-->
<item>
<key>department</key>
<value>customer service</value>
</item>
</searchParams>
</urn:searchEmployee>
</soapenv:Body>
</soapenv:Envelope>

Output: searchEmployeeResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<searchEmployeeResponse xmlns="urn:TBEWebAPI">
<searchEmployeeReturn xmlns="">
<array>
<item>
<id>4</id>
<relevance>1.0</relevance>
</item>
<item>
<id>6</id>
<relevance>1.0</relevance>
</item>
<item>
<id>8</id>
<relevance>1.0</relevance>
</item>
</array>
</searchEmployeeReturn>
</searchEmployeeResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 134


Candidate API Calls
getCandidateById Element:

updateEmployee Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing employee, and sends a
correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the employeeBean (i.e. data is not
appended). Send all elements back or the field values will be returned NULL.

Input:updateEmployeeRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
bean employeeBean[] * flexValues []
id *
status *
city
address
zipCode
state
country
phone
employeeNumber *
email
firstName
middleInitial
lastName *
cellPhone
hiredDate
startDate
race
gender
lockedFromEws
reviewManagerId
departmentId
managerId
locationId
ewsLogin *
ewsPassword *
jobTitle
jobCode
salaryGrade
salary

Taleo Business Edition API Guide Page 135


Candidate API Calls
getCandidateById Element:

payFrequency
changePswdOnEwsLogin
additionalEntities []

Output: updateEmployeeResponse

Data Field Name Data Field Type Required Acceptable Values


updateEmployeeReturn

updateEmployee Test Case:

Input: updateEmployeeRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateEmployee>
<sessionId>webapi7073868042459393355</sessionId>
<bean>
<flexValues>
<!--Zero or more repetitions:-->
<item>
<fieldName>District</fieldName>
<valueStr>Store1</valueStr>
</item>
</flexValues>
<id>137</id>
<status>LOA</status>
<city>Seattle</city>
<address>234 Sandra Ave</address>
<zipCode>578937</zipCode>
<state>US-WA</state>
<country>United States</country>
<phone>754-343-2323</phone>
<employeeNumber>S-54896</employeeNumber>
<email>[email protected]</email>
<firstName>Sharon</firstName>
<middleInitial>A</middleInitial>
<lastName>Darrah</lastName>
<cellPhone>230-234-5895</cellPhone>
<hiredDate>2009-06-30T23:01:26.493Z</hiredDate>

Taleo Business Edition API Guide Page 136


Candidate API Calls
getCandidateById Element:

<startDate>2009-10-01T23:01:26.493Z</startDate>
<race>Hispanic or Latino</race>
<gender>Female</gender>
<lockedFromEws>False</lockedFromEws>
<reviewManagerId>4</reviewManagerId>
<departmentId>2</departmentId>
<managerId>4</managerId>
<locationId>2</locationId>
<ewsLogin>sand</ewsLogin>
<ewsPassword>sand</ewsPassword>
<jobTitle>Consultant</jobTitle>
<jobCode>Consulting</jobCode>
<salaryGrade>Level 1</salaryGrade>
<salary>5600</salary>
<payFrequency>Monthly</payFrequency>
<changePswdOnEwsLogin>False</changePswdOnEwsLogin>
<additionalEntities>
<!--Zero or more repetitions:-->
<item>
</item>
</additionalEntities>
</bean>
</urn:updateEmployee>
</soapenv:Body>
</soapenv:Envelope>

Output: updateEmployeeResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateEmployeeResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

upsertEmployee Element:

Operation type: Request-response.

Taleo Business Edition API Guide Page 137


Candidate API Calls
getCandidateById Element:

 The endpoint receives a message to upsert an existing employee record (create new
andor update existing), and sends a correlated message of the employee ID that has
their data record/elements updated.
 Upsert is the universal create and update command for Taleo Business Edition
API. When using upsertEmployee as create command, use all the field exept
for employeeID, When using upsertEmployee as update command, use all
fields or fields will be defined NULL (same as updateEmployee).

Input:upsertEmployeeRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
Defined Employee
employeeNumber String Yes
Number
bean employeeBean[] * flexValues []
id *
status *
city
address
zipCode
state
country
phone
email
firstName
middleInitial
lastName *
cellPhone
hiredDate
startDate
race
gender
lockedFromEws
reviewManagerId
departmentId
managerId
locationId
ewsLogin *
ewsPassword *
jobTitle
jobCode
salaryGrade
salary

Taleo Business Edition API Guide Page 138


Candidate API Calls
getCandidateById Element:

payFrequency
changePswdOnEwsLogin
additionalEntities []

Output: upsertEmployeeResponse

Data Field Name Data Field Type Required Acceptable Values


upsertEmployeeReturn Long Employee ID

upsertEmployee Test Case:

Input: upsertEmployeeRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:upsertEmployee>
<sessionId>webapi7073868042459393355</sessionId>
<bean>
<flexValues>
<!--Zero or more repetitions:-->
<item>
<fieldName>District</fieldName>
<valueStr>Store1</valueStr>
</item>
</flexValues>
<id>137</id>
<status>Employed</status>
<city>Seattle</city>
<address>234 Sandra Ave</address>
<zipCode>578937</zipCode>
<state>US-WA</state>
<country>United States</country>
<phone>754-343-2323</phone>
<employeeNumber>S-54896</employeeNumber>
<email>[email protected]</email>
<firstName>Sharon</firstName>
<middleInitial>A</middleInitial>
<lastName>Darrah</lastName>
<cellPhone>230-234-5895</cellPhone>
<hiredDate>2009-06-30T23:01:26.493Z</hiredDate>

Taleo Business Edition API Guide Page 139


Candidate API Calls
getCandidateById Element:

<startDate>2009-10-01T23:01:26.493Z</startDate>
<race>Hispanic or Latino</race>
<gender>Female</gender>
<lockedFromEws>False</lockedFromEws>
<reviewManagerId>4</reviewManagerId>
<departmentId>2</departmentId>
<managerId>4</managerId>
<locationId>2</locationId>
<ewsLogin>sand</ewsLogin>
<ewsPassword>sand</ewsPassword>
<jobTitle>Consultant</jobTitle>
<jobCode>Consulting</jobCode>
<salaryGrade>Level 1</salaryGrade>
<salary>5600</salary>
<payFrequency>Monthly</payFrequency>
<changePswdOnEwsLogin>False</changePswdOnEwsLogin>
<additionalEntities>
<!--Zero or more repetitions:-->
<item>
</item>
</additionalEntities>
</bean>
</urn:upsertEmployee>
</soapenv:Body>
</soapenv:Envelope>

Output: upsertEmployeeResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<upsertEmployeeResponse xmlns="urn:TBEWebAPI">
<upsertEmployeeReturn xmlns="">137</upsertEmployeeReturn>
</upsertEmployeeResponse>
</soapenv:Body>
</soapenv:Envelope>

Event API Calls

Taleo Business Edition API Guide Page 140


Candidate API Calls
getCandidateById Element:

Events are calendar tasks stored within a specific entity of Taleo Business Edition. There is a one-
to-many relationship with events to entities. Entities include accounts (ACCT), candidates
(CAND), contacts (CTCT), employees (EMPL), requisitions (REQU) and users (WORK).

calendarEventBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
Account’s unique server side ID. Can be
id long Read Only obtained by searching the accounts’
database or by creating a new account.
status String Yes Account’s Status from pick list
creator String Yes Creator’s login name
entityType String Yes Type of related entity:
ACCT = accounts
CAND = candidates
CTCT = contacts
EMPL = employees
REQU = requisitions
WORK = users
entityId long Yes ID of associated entity
location String No Location of event
subject String Yes Subject of event
“Private event” flag
isPrivate Boolean No True
False
startDate Date Yes Date and time of event begin
duration long Yes Duration of event (in ms)
description String No Description
participants ParticipantBean[] Yes Array of events’ participants
creationDate Date Read Only Creation date
lastUpdated Date Read Only Last updated date
flexValues FlexFieldBean[] No Array of flexible (custom) field values

participantBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
PersonId long Read Only ID of person (user or contact)
PersonType String Yes Type of person object: WORK=user,

Taleo Business Edition API Guide Page 141


Candidate API Calls
getCandidateById Element:

CTCT=contact. Use appropriate API to


extract actual person object using
person’s ID
ID of event (interview, calendar event, or
EventId long Yes
task)
Type of event object: INTV=interview,
CLDEV=calendar event, TASK=task. Use
EventType String Yes
appropriate API to extract actual event
object using event’s ID
StartDate Date No Event's start date for given participant.
EndDate Date No Event's end date for given participant.

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue Boolean No Value of Check Box field
DateValue Date No Value of Date field

createEvent Element:

Operation type: Request-response.


 The endpoint receives a message to create an event, and sends a correlated message of
event ID.

Input: createEventRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 calendarEventBean[] * flexValues []
participantBean [] status *
creator

Taleo Business Edition API Guide Page 142


Candidate API Calls
getCandidateById Element:

description
duration *
entityId *
entityType *
isPrivate type
location
startDate *
subject

participants []
endDate
eventId *
eventType *
personId *
personType *
startDate

Output: createEventResponse

Data Field Name Data Field Type Required Acceptable Values


createEventReturn Long Yes Provided Event ID

createEvent Test Case:

Input: createEventRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createEvent>
<in0>webapi7774524514047942379</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<status>New</status>
<creator>skarim</creator>
<description>Face to face Interview</description>
<duration>50000</duration>
<entityId>48</entityId>
<entityType>CAND</entityType>

Taleo Business Edition API Guide Page 143


Candidate API Calls
getCandidateById Element:

<isPrivate>True</isPrivate>
<location>Meeting Room 1</location>
<participants>
<!--Zero or more repetitions:-->
<item>
<endDate>2009-06-30T23:01:26.493Z</endDate>
<eventType>CLDEV</eventType>
<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</item>
</participants>
<startDate>2009-06-30T23:01:26.493Z</startDate>
<subject>Interview</subject>
</in1>
</urn:createEvent>
</soapenv:Body>
</soapenv:Envelope>

Output: createEventResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createEventResponse xmlns="urn:TBEWebAPI">
<createEventReturn xmlns="">1</createEventReturn>
</createEventResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteEvent Element:

Operation type: Request-response.


 The endpoint receives a message to delete an event instance, and sends a correlated
message only if error occurred.

Input: deleteEventRequest

Taleo Business Edition API Guide Page 144


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


in0
Session ID received at
String Yes
Login

in1
Event ID Yes ID of Event

Output: deleteEventResponse

Data Field Name Data Field Type Required Acceptable Values


deleteEventReturn

deleteEvent Test Case:

Input: deleteEventRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteEvent>
<in0>webapi5722630372091424901</in0>
<in1>2</in1>
</urn:deleteEvent>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteEventResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteEventResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 145


Candidate API Calls
getCandidateById Element:

getEventByEntity Element:

Operation type: Request-response.


 The endpoint receives a message to get event(s) associated with any Taleo Business
Edition entity that supports storing/creation of calendar events, and sends back event
IDs associated with the entity ID.

Input: getEventByEntityRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
Type of related entity:
ACCT = accounts
CAND = candidates
in1 Long Yes
EMPL = employees
REQU = requisitions
WORK = users
in2 Long Yes ID of associated entity

Output: getEventByEntityResponse

Data Field Name Data Field Type Required Acceptable Values


getEventByEntityReturn array of event IDs

getEventByEntity Test Case:

Input: getEventByEntityRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getEventByEntity>
<in0>webapi7774524514047942379</in0>
<in1>CAND</in1>
<in2>48</in2>
</urn:getEventByEntity>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 146


Candidate API Calls
getCandidateById Element:

Output: getEventByEntityResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getEventByEntityResponse xmlns="urn:TBEWebAPI">
<getEventByEntityReturn xmlns="">
<array>
<item>1</item>
<item>3</item>
<item>7</item>
</array>
</getEventByEntityReturn>
</getEventByEntityResponse>
</soapenv:Body>
</soapenv:Envelope>

getEventById Element:

Operation type: Request-response.


 The endpoint receives a message to get event details by event ID, and sends a correlated
message of event information.

Input: getEventByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Event ID Yes ID of Event Instance

Output: getEventByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getEventByIdReturn calendarEventBean []

getEventById Test Case:

Input: getEventByIdRequest

Taleo Business Edition API Guide Page 147


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getEventById>
<in0>webapi7774524514047942379</in0>
<in1>1</in1>
</urn:getEventById>
</soapenv:Body>
</soapenv:Envelope>

Output: getEventByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getEventByIdResponse xmlns="urn:TBEWebAPI">
<getEventByIdReturn xmlns="">
<creationDate>2009-09-11T06:47:54.527Z</creationDate>
<flexValues/>
<id>1</id>
<lastUpdated>2009-09-11T07:01:55.452Z</lastUpdated>
<status>Created</status>
<creator>skarim</creator>
<description>Face to face Interview</description>
<duration>7200000</duration>
<entityId>48</entityId>
<entityType>CAND</entityType>
<isPrivate>true</isPrivate>
<location>Meeting Room 1</location>
<participants>
<item>
<endDate>2009-06-30T02:00:00.000Z</endDate>
<eventId>1</eventId>
<eventType>CLDEV</eventType>
<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T00:00:00.000Z</startDate>
</item>
</participants>
<startDate>2009-06-30T00:00:00.000Z</startDate>

Taleo Business Edition API Guide Page 148


Candidate API Calls
getCandidateById Element:

<subject>Interview</subject>
</getEventByIdReturn>
</getEventByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

getPublicEvents Element:

Operation type: Request-response.


 The endpoint receives a message to get all public events within a start date and end
date, and sends a correlated message array of event IDs.

Input: getPublicEventsRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
Start of start date
in1 dateTime Yes
interval
End of start date
in2 dateTime Yes
interval

Output: getPublicEventsResponse

Data Field Name Data Field Type Required Acceptable Values


getPublicEventsReturn array of Event IDs

getPublicEvents Test Case:

Input: getPublicEventsRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getPublicEvents>
<in0>webapi-6686750025617579220</in0>
<in1>2007-06-30T00:00:00.000Z</in1>
<in2>2010-06-30T00:00:00.000Z</in2>
</urn:getPublicEvents>

Taleo Business Edition API Guide Page 149


Candidate API Calls
getCandidateById Element:

</soapenv:Body>
</soapenv:Envelope>

Output: getPublicEventsResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getPublicEventsResponse xmlns="urn:TBEWebAPI">
<getPublicEventsReturn xmlns="">
<array/>
</getPublicEventsReturn>
</getPublicEventsResponse>
</soapenv:Body>
</soapenv:Envelope>

updateEvent Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing calendar event, and sends a
correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the calendarEventBean (i.e. data
is not appended or upserted). Send all elements back or the field values will be returned
NULL.

Input: updateEventRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 calendarEventBean[] * flexValues []
id *
status *
creator
description
duration *
entityId *
entityType *
isPrivate type
location
startDate *

Taleo Business Edition API Guide Page 150


Candidate API Calls
getCandidateById Element:

subject

participants []
endDate
eventId *
eventType *
personId *
personType *
startDate

Output: updateEventResponse

Data Field Name Data Field Type Required Acceptable Values


updateEventReturn

updateEvent Test Case:

Input: updateEventRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateEvent>
<in0>webapi5722630372091424901</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<id>7</id>
<status>New</status>
<creator>skarim</creator>
<description>Face to face interview</description>
<duration>500000</duration>
<entityId>48</entityId>
<entityType>CAND</entityType>
<isPrivate>False</isPrivate>
<location>Meeting Room A</location>
<participants>
<!--Zero or more repetitions:-->
<item>

Taleo Business Edition API Guide Page 151


Candidate API Calls
getCandidateById Element:

<endDate>2009-06-30T02:00:00.000Z</endDate>
<eventType>TASK</eventType>
<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T00:00:00.000ZZ</startDate>
</item>
</participants>
<startDate>2009-06-30T00:00:00.000Z</startDate>
<subject>Interview</subject>
</in1>
</urn:updateEvent>
</soapenv:Body>
</soapenv:Envelope>

Output: updateEventResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateEventResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Interview API Calls


Interview Bean is where to find details regarding an interview associated with any candidate in
Taleo Business Edition. Similar to background checks, there is a one-to-many relationship with
intervies to candidates.

interviewBean Definition:

Data Field Name Data Field Type Required Acceptable Values


Account’s unique server side ID. Can be
Id (read-only) long Read Only obtained by searching the accounts’
database or by creating a new account.
Status String Yes Account’s Status from pick list
CandidateId long Yes ID of candidate

Taleo Business Edition API Guide Page 152


Candidate API Calls
getCandidateById Element:

RequisitionId long Yes ID of requisition


InterviewType
String Yes Interview type (from pick list)

StartDate
Date Yes Interview start date and time

InterviewRoom
String No Interview room (location)

Comments
String No Comments

Creator
String No Creator’s login name

Participants
ParticipantBean[] No Array of events’ participants

CreationDate
(read-only) Date Read Only Creation date

LastUpdated
(read-only) Date Read Only Last updated date

FlexValues
FlexFieldBean[] No Array of flexible (custom) field values

participantBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
PersonId long Read Only ID of person (user or contact)
Type of person object: WORK=user,
CTCT=contact. Use appropriate API to
PersonType String Yes
extract actual person object using
person’s ID
ID of event (interview, calendar event, or
EventId long Yes
task)
EventType String Yes Type of event object: INTV=interview,
CLDEV=calendar event, TASK=task. Use

Taleo Business Edition API Guide Page 153


Candidate API Calls
getCandidateById Element:

appropriate API to extract actual event


object using event’s ID
StartDate
Date No Event's start date for given participant.

EndDate
Date No Event's end date for given participant.

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue boolean No Value of Check Box field
DateValue Date No Value of Date field

createInterview Element:

Operation type: Request-response.


 The endpoint receives a message to create an interview instance for a specific candidate,
and sends a correlated message of interview ID.

Input: createInterviewRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 interviewBean [] * flexValues []
participantBean [] status *
candidateID *
comments
creator
interviewRoom
interviewType *
requisitionID *

Taleo Business Edition API Guide Page 154


Candidate API Calls
getCandidateById Element:

startDate *

participants []
endDate
eventId
eventType
personId
personType
startDate

Output: createInterviewResponse

Data Field Name Data Field Type Required Acceptable Values


createInterviewReturn Long Yes Provided Interview ID

createInterview Test Case:

Input: createInterviewRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createInterview>
<in0>webapi411835895647962205</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<status>Phone Screen</status>
<candidateId>48</candidateId>
<comments>Direct Report</comments>
<creator>skarim</creator>
<interviewRoom>Whistler</interviewRoom>
<interviewType>1st Interview</interviewType>
<participants>
<!--Zero or more repetitions:-->
<item>
<endDate>2009-06-30T23:01:26.493Z</endDate>
<eventId>2</eventId>
<eventType>TASK</eventType>

Taleo Business Edition API Guide Page 155


Candidate API Calls
getCandidateById Element:

<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</item>
</participants>
<requisitionId>13</requisitionId>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</in1>
</urn:createInterview>
</soapenv:Body>
</soapenv:Envelope>

Output: createInterviewResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createInterviewResponse xmlns="urn:TBEWebAPI">
<createInterviewReturn xmlns="">2</createInterviewReturn>
</createInterviewResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteInterview Element:

Operation type: Request-response.


 The endpoint receives a message to delete an interview instance, and sends a correlated
message only if error occurred.

Input: deleteInterviewRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Interview ID Yes ID of Interview

Output: deleteInterviewResponse

Data Field Name Data Field Type Required Acceptable Values

Taleo Business Edition API Guide Page 156


Candidate API Calls
getCandidateById Element:

deleteInterviewReturn

deleteInterview Test Case:

Input: deleteInterviewRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteInterview>
<in0>webapi411835895647962205</in0>
<in1>2</in1>
</urn:deleteInterview>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteInterviewResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteInterviewResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getInterviewsByCandidate Element:

Operation type: Request-response.


 The endpoint receives a message to get interview(s) associated with any Taleo Business
Edition candidate, and sends back interview IDs associated for the candidate ID.

Input: getInterviewsByCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of candidate

Taleo Business Edition API Guide Page 157


Candidate API Calls
getCandidateById Element:

Output: getInterviewsByCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


array of interview
getInterviewsByCandidateReturn
IDs

getInterviewsByCandidate Test Case:

Input: getInterviewsByCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getInterviewsByCandidate>
<in0>webapi411835895647962205</in0>
<in1>48</in1>
</urn:getInterviewsByCandidate>
</soapenv:Body>
</soapenv:Envelope>

Output: getInterviewsByCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getInterviewsByCandidateResponse xmlns="urn:TBEWebAPI">
<getInterviewsByCandidateReturn xmlns="">
<array>
<item>2</item>
<item>1</item>
</array>
</getInterviewsByCandidateReturn>
</getInterviewsByCandidateResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 158


Candidate API Calls
getCandidateById Element:

getInterviewById Element:

Operation type: Request-response.


 The endpoint receives a message to get interview details by interview ID, and sends a
correlated message of interview information.

Input: getInterviewByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
ID of Interview
in1 Interview ID Yes
Instance

Output: getInterviewByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getInterviewByIdReturn interviewBean []

getInterviewById Test Case:

Input: getInterviewByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getInterviewById>
<in0>webapi411835895647962205</in0>
<in1>1</in1>
</urn:getInterviewById>
</soapenv:Body>
</soapenv:Envelope>

Output: getInterviewByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getInterviewByIdResponse xmlns="urn:TBEWebAPI">
<getInterviewByIdReturn xmlns="">

Taleo Business Edition API Guide Page 159


Candidate API Calls
getCandidateById Element:

<creationDate>2009-09-11T19:36:37.574Z</creationDate>
<flexValues/>
<id>1</id>
<lastUpdated>2009-09-11T19:36:37.574Z</lastUpdated>
<status>Feedback Pending</status>
<candidateId>48</candidateId>
<comments xsi:nil="true"/>
<creator>skarim</creator>
<interviewRoom xsi:nil="true"/>
<interviewType>1st Interview</interviewType>
<participants>
<item>
<endDate>2009-06-30T23:01:26.493Z</endDate>
<eventId>1</eventId>
<eventType>INTV</eventType>
<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</item>
</participants>
<requisitionId>13</requisitionId>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</getInterviewByIdReturn>
</getInterviewByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

updateInterview Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing interview instance, and sends a
correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the interviewBean (i.e. data is not
appended or upserted). Send all elements back or the field values will be returned NULL.

Input: updateInterviewRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 interviewBean[] * flexValues []

Taleo Business Edition API Guide Page 160


Candidate API Calls
getCandidateById Element:

participantBean [] id *
status *
candidateID *
comments
creator
interviewRoom
interviewType *
requisitionID *
startDate *

participants []
endDate
eventId
eventType
personId
personType
startDate

Output: updateInterviewResponse

Data Field Name Data Field Type Required Acceptable Values


updateInterviewReturn

updateInterview Test Case:

Input: updateInterviewRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateInterview>
<in0>webapi411835895647962205</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<id>1</id>
<status>Feedback Pending</status>
<candidateId>48</candidateId>
<comments>Direct Report</comments>

Taleo Business Edition API Guide Page 161


Candidate API Calls
getCandidateById Element:

<creator>skarim</creator>
<interviewRoom>Whistler</interviewRoom>
<interviewType>1st Interview</interviewType>
<participants>
<!--Zero or more repetitions:-->
<item>
<endDate>2009-06-30T23:01:26.493Z</endDate>
<eventId>2</eventId>
<eventType>TASK</eventType>
<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</item>
</participants>
<requisitionId>13</requisitionId>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</in1>
</urn:updateInterview>
</soapenv:Body>
</soapenv:Envelope>

Output: updateInterviewResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateInterviewResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Link API Calls


Links are what tie one entity attribute to another. For example, linking a candidate to a
requisition, or an attachment to a candidate. Full list of entities include:
 Account = ACCT
 Candidate = CAND
 Contact = CTCT
 Requisition = REQU
 User = WORK

Taleo Business Edition API Guide Page 162


Candidate API Calls
getCandidateById Element:

Where the following linkage is available:


 ACCT to REQU
 CTCT to REQU
 ACCT to CAND
 CTCT to CAND
 CAND to WORK

createLink Element:

Operation type: Request-response.


 The endpoint receives a message to Link an entity (by ID) to another entity (by ID) in
Taleo Business Edition, and sends a correlated message only if error occured.

Input: createLinkRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID obtained at
sessionID String Yes
login
entityType as
entityType1 String Yes
provided in above list
entityId1 String Yes ID of entity type 1
entityType as
entityType2 String Yes
provided in above list
entityId2 String Yes ID of entity type 2

Output: createLinkResponse

Data Field Name Data Field Type Required Acceptable Values


createLinkReturn

Link Test Case:

Input: createLinkRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createLink>

Taleo Business Edition API Guide Page 163


Candidate API Calls
getCandidateById Element:

<sessionId>webapi-8948403736913319968</sessionId>
<entityType1>ACCT</entityType1>
<entityId1>2</entityId1>
<entityType2>REQU</entityType2>
<entityId2>16</entityId2>
</urn:createLink>
</soapenv:Body>
</soapenv:Envelope>

Output: createLinkResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createLinkResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

removeLink Element:

Operation type: Request-response.


 The endpoint receives a message to remove Linkage between two entities in Taleo
Business Edition, and sends a correlated message only if error occured.

Input: removeLinkRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID obtained at
sessionID String Yes
login
entityType as
entityType1 String Yes
provided in above list
entityId1 String Yes ID of entity type 1
entityType as
entityType2 String Yes
provided in above list
entityId2 String Yes ID of entity type 2

Output: removeLinkResponse

Data Field Name Data Field Type Required Acceptable Values

Taleo Business Edition API Guide Page 164


Candidate API Calls
getCandidateById Element:

removeLinkReturn

Link Test Case:

Input: removeLinkRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:removeLink>
<sessionId>webapi-8948403736913319968</sessionId>
<entityType1>ACCT</entityType1>
<entityId1>2</entityId1>
<entityType2>REQU</entityType2>
<entityId2>16</entityId2>
</urn:removeLink>
</soapenv:Body>
</soapenv:Envelope>

Output: removeLinkResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<removeLinkResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Login API Calls


Login calls are all the information associated with an API users login details and session variables.

getUrl Element

Taleo Business Edition API Guide Page 165


Candidate API Calls
getCandidateById Element:

Operation type: Request-response.


 The endpoint receives a message to get URL of a company code, or customer instance,
and sends a correlated message of URL.
 This call is always performed using URL:
https://tbe.taleo.net/MANAGER/dispatcher/servlet/rpcrouter and requires a different
Namespace: urn:TBEDispatcherAPI (vs. urn:TBEWebAPI)

Input: getURLRequest

Data Field Name Data Field Type Required Acceptable Values


Company Code of
in0 String Yes
Taleo Customer

Output: getURLResponse

Data Field Name Data Field Type Required Acceptable Values


getURLReturn String URL

getURL Test Case:

Input: getURLRequest

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEDispatcherAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getURL soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<orgCode xsi:type="xsd:string">TALEOSK</orgCode>
</urn:getURL>
</soapenv:Body>
</soapenv:Envelope>

Output: getURLResponse

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>

Taleo Business Edition API Guide Page 166


Candidate API Calls
getCandidateById Element:

<ns1:getURLResponse SOAP-
ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="urn:TBEDispatcherAPI">
<return xsi:type="xsd:string">https://tbe.taleo.net/NA12/ats/services/rpcrouter</return>
</ns1:getURLResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

login Element:

Operation type: Request-response.


 This and all subsequent calls are made using the URL returned by the getURL() method
described above. This call returns session ID to be used in all subsequent calls to TBE
Web API.
 The endpoint receives a message to login to the Taleo Business Edition API, and sends a
correlated message of session ID.
 An existing user needs to be created within the application first, and then can be used
with the Taleo Business Edition API.
 Please Note: login credentials used are subjected to the same user abilities within the
application.

Input: loginRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Company Code
in1 String Yes User ID
in2 String Yes Password

Output: loginResponse

Data Field Name Data Field Type Required Acceptable Values


loginReturn String Session ID

login Test Case:

Input: loginRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>

Taleo Business Edition API Guide Page 167


Candidate API Calls
getCandidateById Element:

<soapenv:Body>
<urn:login>
<in0>ABC_COMPANY</in0>
<in1>API_USER</in1>
<in2>API_PASSWORD</in2>
</urn:login>
</soapenv:Body>
</soapenv:Envelope>

Output: loginResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<loginResponse xmlns="urn:TBEWebAPI">
<loginReturn xmlns="">webapi-7677111958344909818</loginReturn>
</loginResponse>
</soapenv:Body>
</soapenv:Envelope>

logout Element:

Operation type: Request-response.


 The endpoint receives a message to logout of the Taleo Business Edition API, and sends a
correlated message if error occurred.

Input: logoutRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Session ID

Output: logoutResponse

Data Field Name Data Field Type Required Acceptable Values


logoutReturn Session ID

logout Test Case:

Taleo Business Edition API Guide Page 168


Candidate API Calls
getCandidateById Element:

Input: logoutRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:logout>
<in0>webapi-7677111958344909818</in0>
</urn:logout>
</soapenv:Body>
</soapenv:Envelope>

Output: logoutResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<logoutResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getLoginToken Element:

Operation type: Request-response.


 The endpoint receives a message to retrieve the token results of a login session ID
variable.

Input: getLoginTokenRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Session ID

Output: getLoginTokenResponse

Data Field Name Data Field Type Required Acceptable Values


getLoginTokenReturn String Login session ID

Taleo Business Edition API Guide Page 169


Candidate API Calls
getCandidateById Element:

getLoginToken Test Case:

Input: getLoginTokenRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getLoginToken>
<sessionId>webapi-7677111958344909818</sessionId>
</urn:getLoginToken>
</soapenv:Body>
</soapenv:Envelope>

Output: getLoginTokenResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getLoginTokenResponse xmlns="urn:TBEWebAPI">
<getLoginTokenReturn xmlns="">5Z0Xz_gyn8Qf6C-_rZ3_M_001f</getLoginTokenReturn>
</getLoginTokenResponse>
</soapenv:Body>
</soapenv:Envelope>

Metadata / Picklist API Calls


Metadata and picklist fields are any field (standard or custom) that associate drop-down list of
values for data consistency. These picklist values require exact replication to be associated with
the specific call in Taleo Business Edition.

getLookup Element:

Operation type: Request-response.


 The endpoint receives a message to lookup picklist values for a given field, and sends a
correlated message of field picklist values and integration codes (if used).

Taleo Business Edition API Guide Page 170


Candidate API Calls
getCandidateById Element:

 Please Note: Country and State/Province lookup integration codes do not work as of
9.01. To use Country and State/Province via the API, use field values solely.

Input: getLookupRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Session ID
in1 String Yes fieldName

Output: getLookupResponse

Data Field Name Data Field Type Required Acceptable Values


array of fieldname
values (display name
getLookupReturn
and integration code
name).

getLookup Test Case:

Input: getLookupRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getLookup>
<in0>webapi-6686750025617579220</in0>
<in1>race</in1>
</urn:getLookup>
</soapenv:Body>
</soapenv:Envelope>

Output: getLookupResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>

Taleo Business Edition API Guide Page 171


Candidate API Calls
getCandidateById Element:

<getLookupResponse xmlns="urn:TBEWebAPI">
<getLookupReturn xmlns="">
<array>
<item>
<displayName>Hispanic or Latino</displayName>
<integrationCode>HISP</integrationCode>
</item>
<item>
<displayName>White (not Hispanic or Latino)</displayName>
<integrationCode>WHIT</integrationCode>
</item>
<item>
<displayName>Black or African American (not Hispanic or Latino)</displayName>
<integrationCode>BLCK</integrationCode>
</item>
<item>
<displayName>Native Hawaiian or Other Pacific Islander</displayName>
<integrationCode>PACF</integrationCode>
</item>
<item>
<displayName>Asian (not Hispanic or Latino)</displayName>
<integrationCode>ASIN</integrationCode>
</item>
<item>
<displayName>American Indian or Alaska Native</displayName>
<integrationCode>INDI</integrationCode>
</item>
<item>
<displayName>Two or More Races (not Hispanic or Latino)</displayName>
<integrationCode>MULT</integrationCode>
</item>
<item>
<displayName>Choose Not to Disclose</displayName>
<integrationCode>NDIS</integrationCode>
</item>
</array>
</getLookupReturn>
</getLookupResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 172


Candidate API Calls
getCandidateById Element:

getMetadata Element:

Operation type: Request-response.


 The endpoint receives a message to retrieve all field values within an entity, and sends a
correlated message of all fields within the entity including:
o displayName (application field name)
o integrationName (API / external field name)
o isCustom (whether the field is a standard or custom field in TBE)
o isReadOnly (whether the field is writable or read-only)
o isRequired (whether the field is application-required for data entry)
o type (the type of field defined)

Input: getMetadataRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Session ID
in1 String Yes Type of related entity:
ACCT = accounts
CAND = candidates
CTCT = contacts
EMPL = employees
REQU = requisitions
WORK = users

Output: getMetadataResponse

Data Field Name Data Field Type Required Acceptable Values


Array of fieldname
values (display name
getMetadataReturn
and integration code
name).

getMetadata Test Case:

Input: getMetadataRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getMetadata>

Taleo Business Edition API Guide Page 173


Candidate API Calls
getCandidateById Element:

<in0>webapi-301034357717673686</in0>
<in1>CAND</in1>
</urn:getMetadata>
</soapenv:Body>
</soapenv:Envelope>

Output: getMetadataResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getMetadataResponse xmlns="urn:TBEWebAPI">
<getMetadataReturn xmlns="">
<array>
<item>
<item>
<displayName>Current Salary.</displayName>
<integrationName>Current Salary</integrationName>
<isCustom>true</isCustom>
<isReadOnly>false</isReadOnly>
<isRequired>false</isRequired>
<type>FieldCurrency</type>
</item>
<item>
<displayName>Current User Department</displayName>
<integrationName>currUserDept</integrationName>
<isCustom>false</isCustom>
<isReadOnly>true</isReadOnly>
<isRequired>false</isRequired>
<type>CurrUserDepartment</type>
</item>
<item>
<displayName>Last updated</displayName>
<integrationName>lastUpdated</integrationName>
<isCustom>false</isCustom>
<isReadOnly>true</isReadOnly>
<isRequired>false</isRequired>
<type>FieldDateLong</type>
</item>
<item>
<displayName>Mobile #</displayName>
<integrationName>cellPhone</integrationName>

Taleo Business Edition API Guide Page 174


Candidate API Calls
getCandidateById Element:

<isCustom>false</isCustom>
<isReadOnly>false</isReadOnly>
<isRequired>false</isRequired>
<type>FieldPhone</type>
</item>
<item>
<displayName>Work Authorization</displayName>
<integrationName>legalStatus</integrationName>
<isCustom>false</isCustom>
<isReadOnly>false</isReadOnly>
<isRequired>false</isRequired>
<type>FieldSingleList</type>
</item>
<item>
<displayName>ZIP/Postal code</displayName>
<integrationName>zipCode</integrationName>
<isCustom>false</isCustom>
<isReadOnly>false</isReadOnly>
<isRequired>false</isRequired>
<type>FieldTextLang</type>
</item>
</array>
</getMetadataReturn>
</getMetadataResponse>
</soapenv:Body>
</soapenv:Envelope>

Offer API Calls


Offers are details and original offer letters associated with any candidate in Taleo Business
Edition. Similar to background checks, there is a one-to-many relationship with references to
candidates.

offerBean Definition:

Data Field Name Data Field Type Required Acceptable Values


id long Offer’s unique server side ID. Can be
obtained enumerating offers for
Read Only
particular candidate or by creating a
new offer.
status String Yes Offer’s Status from pick list

Taleo Business Edition API Guide Page 175


Candidate API Calls
getCandidateById Element:

manager String Yes Login name of offer’s manager


candidateId long Yes Id of candidate related to this offer

requisitioned long Yes Id of requisition related to this offer

creator String Read Only Login name of user who has created
this offer

title String Title of position offered


Yes

employmentType String Type of employment (from pick list)


Yes offered

payRate String No Pay rate (free text) offered

stockOptions String No Stock options (free text) offered

startDate Date No Date when employment will start

expirationDate Date No Date when offer will expire

offerFileName String Binary offer file name


Read Only

creationDate Date Creation date


Read Only

lastUpdated Date Last updated date


Read Only

flexValues FlexFieldBean[] Array of flexible (custom) field values


No

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name

Taleo Business Edition API Guide Page 176


Candidate API Calls
getCandidateById Element:

StringValue String No Value of Text, Email, URL, Pick list, or Text


Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue
int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue boolean No Value of Check Box field
DateValue Date No Value of Date field

createOffer Element:

Operation type: Request-response.


 The endpoint receives a message to create an offer for a specific candidate, and sends a
correlated message of offer ID.

Input: createOfferRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
status *
candidateId *
employmentType *
expirationDate
manager *
in1 offerBean [] *
offerFileName
payRate
requisitionId *
startDate
stockOptions
title *

Output: createOfferResponse

Data Field Name Data Field Type Required Acceptable Values


createOfferReturn Long Yes Provided Offer ID

createOffer Test Case:

Taleo Business Edition API Guide Page 177


Candidate API Calls
getCandidateById Element:

Input: createOfferRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createOffer>
<in0>webapi411835895647962205</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<status>New</status>
<candidateId>48</candidateId>
<employmentType>Full time</employmentType>
<expirationDate>2010-06-30T23:01:26.493Z</expirationDate>
<manager>skarim</manager>
<offerFileName>test1.docx</offerFileName>
<payRate>50000</payRate>
<requisitionId>13</requisitionId>
<startDate>2009-06-30T23:01:26.493Z</startDate>
<stockOptions>True</stockOptions>
<title>Offer Business Development</title>
</in1>
</urn:createOffer>
</soapenv:Body>
</soapenv:Envelope>

Output: createOfferResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createOfferResponse xmlns="urn:TBEWebAPI">
<createOfferReturn xmlns="">1</createOfferReturn>
</createOfferResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 178


Candidate API Calls
getCandidateById Element:

deleteOffer Element:

Operation type: Request-response.


 The endpoint receives a message to delete an offer instance, and sends a correlated
message only if error occurred.

Input: deleteOfferRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Offer ID Yes ID of Offer

Output: deleteOfferResponse

Data Field Name Data Field Type Required Acceptable Values


deleteOfferReturn

deleteOffer Test Case:

Input: deleteOfferRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteOffer>
<in0>webapi8016094028063300532</in0>
<in1>4</in1>
</urn:deleteOffer>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteOfferResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteOfferResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>

Taleo Business Edition API Guide Page 179


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

getBinaryOffer Element:

Operation type: Request-response.


 The endpoint receives a message to get the offer letter binary attachment associated
with a candidate (based on offer ID), and sends back the resume binary offer letter data.

Input: getBinaryOfferRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of offer instance

Output: getBinaryResumeResponse

Data Field Name Data Field Type Required Acceptable Values


getBinaryOfferReturn base64Binary []

Input: getBinaryOfferRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn: getBinaryOffer>
<in0>webapi1673199911353581754</in0>
<in1>41</in1>
</urn: getBinaryOffer>
</soapenv:Body>
</soapenv:Envelope>

Output: getBinaryOfferResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>

Taleo Business Edition API Guide Page 180


Candidate API Calls
getCandidateById Element:

< getBinaryOfferResponse xmlns="urn:TBEWebAPI">


< getBinaryOfferReturn xmlns="">
<array>UEsDBBQABgAIAAAAIQAwySgMcgEAAKUFAAATA ==</array>
</ getBinaryOfferReturn>
</ getBinaryOfferResponse>
</soapenv:Body>
</soapenv:Envelope>

getOfferByID

Operation type: Request-response.


 The endpoint receives a message to get offer details by offer ID, and sends a correlated
message of offer information.

Input: getOfferByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Offer ID Yes ID of Offer Instance

Output: getOfferByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getOfferByIdReturn referenceBean []

getOfferById Test Case:

Input: getOfferByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getOfferById>
<in0>webapi8016094028063300532</in0>
<in1>3</in1>
</urn:getOfferById>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 181


Candidate API Calls
getCandidateById Element:

Output: getOfferByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getOfferByIdResponse xmlns="urn:TBEWebAPI">
<getOfferByIdReturn xmlns="">
<creationDate>2009-09-11T21:01:22.793Z</creationDate>
<flexValues/>
<id>3</id>
<lastUpdated>2009-09-11T23:33:39.087Z</lastUpdated>
<status>Draft</status>
<candidateId>48</candidateId>
<creator>skarim</creator>
<employmentType>FULLTIME</employmentType>
<expirationDate>2010-06-30T00:00:00.000Z</expirationDate>
<manager>skarim</manager>
<offerFileName>offer_3.rt</offerFileName>
<payRate>50000</payRate>
<requisitionId>13</requisitionId>
<startDate>2009-06-30T00:00:00.000Z</startDate>
<stockOptions>True</stockOptions>
<title>Offer Business Development</title>
</getOfferByIdReturn>
</getOfferByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

getOffers Element:

Operation type: Request-response.


 The endpoint receives a message to get offer(s) associated with any Taleo Business
Edition candidate, and sends back offer IDs associated with the candidate ID.

Input: getOffersRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login

Taleo Business Edition API Guide Page 182


Candidate API Calls
getCandidateById Element:

in1 Long Yes ID of candidate

Output: getOffersResponse

Data Field Name Data Field Type Required Acceptable Values


getOffersReturn array of offer IDs

getOffers Test Case:

Input: getOffersRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getOffers>
<in0>webapi8016094028063300532</in0>
<in1>48</in1>
</urn:getOffers>
</soapenv:Body>
</soapenv:Envelope>

Output: getOffersResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getOffersResponse xmlns="urn:TBEWebAPI">
<getOffersReturn xmlns="">
<array>
<item>3</item>
<item>2</item>
<item>1</item>
</array>
</getOffersReturn>
</getOffersResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 183


Candidate API Calls
getCandidateById Element:

setBinaryOffer

Operation type: Request-response.


 The endpoint receives a message to append an offer letter attachment by offer ID, and
sends a correlated message only if error occurred.

Input: setBinaryOfferRequest

Data Field Required


Data Field Type Acceptable Values
Name
in0 String Yes Session ID received at Login
in1 Offer ID Yes ID of Offer Instance
Filename of binary file with defined file
extension. The following MIME types are
acceptable:
Text = text/plain
html = text/html
in2 String Yes RTF = text/richtext
Word = application/msword
DocX =
application/vnd.openxmlformats-
officedocument.wordprocessingml.document
PDF = application/pdf
in3 ByteArr Yes base64Binary []

Output: setBinaryOfferResponse

Data Field Name Data Field Type Required Acceptable Values


setBinaryOfferReturn

setBinaryOffer Test Case:

Input: setBinaryOfferRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">

Taleo Business Edition API Guide Page 184


Candidate API Calls
getCandidateById Element:

<soapenv:Header/>
<soapenv:Body>
<urn:setBinaryOffer>
<in0>webapi8016094028063300532</in0>
<in1>2</in1>
<in2>offer_letter.doc</in2>
<in3>
<array>e1xydGYxXGFuc2lcYW5zaWNwZzEyNTJcdWMxIFxkZWZmM==</array>
</in3>
</urn:setBinaryOffer>
</soapenv:Body>
</soapenv:Envelope>

Output: setBinaryOfferResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<setBinaryOfferResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

updateOffer Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing offer instance, and sends a
correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the offerBean (i.e. data is not
appended or upserted). Send all elements back or the field values will be returned NULL.

Input: updateOfferRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 offerBean[] * flexValues []
id *
status *
candidateId *

Taleo Business Edition API Guide Page 185


Candidate API Calls
getCandidateById Element:

creator
employmentType
expirationDate
manager *
offerFileName
payRate
requisitionId *
startDate
stockOptions
title *

Output: updateOfferResponse

Data Field Name Data Field Type Required Acceptable Values


updateOfferReturn

updateOffer Test Case:

Input: updateOfferRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateOffer>
<in0>webapi-5084000498747541653</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<id>1</id>
<status>Draft</status>
<candidateId>48</candidateId>
<creator>destey</creator>
<employmentType>Full time</employmentType>
<expirationDate>2010-06-30T23:01:26.493Z</expirationDate>
<manager>skarim</manager>
<offerFileName>test1.docx</offerFileName>
<payRate>75000</payRate>
<requisitionId>13</requisitionId>
<startDate>2009-06-30T23:01:26.493Z</startDate>
<stockOptions>True</stockOptions>

Taleo Business Edition API Guide Page 186


Candidate API Calls
getCandidateById Element:

<title>Bus Dev Manager</title>


</in1>
</urn:updateOffer>
</soapenv:Body>
</soapenv:Envelope>

Output: updateOfferResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateOfferResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Reference API Calls


References are personal references associated with any candidate in Taleo Business Edition.
Similar to background checks, there is a one-to-many relationship with references to candidates.

referenceBean Definition:

Data Field Name Data Field Type Required Acceptable Values


id long Account’s unique server side ID. Can be
Read Only obtained by searching the accounts’
database or by creating a new account.
status String Yes Account’s Status from pick list
creator String No Creator’s login name
candidateId long Yes ID of candidate
refName String Yes Reference's name
refPhone String No Reference's phone
refEmail String No Reference's email
refTitle String No Reference's title
employer String No Employer’s name
relToCandidate String No Relation to candidate
comments String No Comments
creationDate Date Read Only Creation date

Taleo Business Edition API Guide Page 187


Candidate API Calls
getCandidateById Element:

lastUpdated Date Read Only Last updated date


flexValues FlexFieldBean[] Array of flexible (custom) field values
No

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue boolean No Value of Check Box field
DateValue Date No Value of Date field

createReference Element:

Operation type: Request-response.


 The endpoint receives a message to create a reference for a specific candidate, and
sends a correlated message of reference ID.

Input: createReferenceRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 referenceBean [] * flexValues []
status *
candidateId *
comments
creator
employer
refEmail
refName *
refPhone
refTitle

Taleo Business Edition API Guide Page 188


Candidate API Calls
getCandidateById Element:

relToCandidate

Output: createReferenceResponse

Data Field Name Data Field Type Required Acceptable Values


createReferenceReturn Long Yes Provided Reference ID

createReference Test Case:

Input: createReferenceRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createReference>
<in0>webapi411835895647962205</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<status>New</status>
<candidateId>48</candidateId>
<comments>Candidate's major strength is selling and buying</comments>
<creator>skarim</creator>
<employer>Nordstroms</employer>
<refEmail>[email protected]</refEmail>
<refName>Sally Store</refName>
<refPhone>948-234-4958</refPhone>
<refTitle>Manager</refTitle>
<relToCandidate>Direct Manager</relToCandidate>
</in1>
</urn:createReference>
</soapenv:Body>
</soapenv:Envelope>

Output: createReferenceResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

Taleo Business Edition API Guide Page 189


Candidate API Calls
getCandidateById Element:

<soapenv:Body>
<createReferenceResponse xmlns="urn:TBEWebAPI">
<createReferenceReturn xmlns="">1</createReferenceReturn>
</createReferenceResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteReference Element:

Operation type: Request-response.


 The endpoint receives a message to delete a reference instance, and sends a correlated
message only if error occurred.

Input: deleteReferenceRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Reference ID Yes ID of Reference

Output: deleteReferenceResponse

Data Field Name Data Field Type Required Acceptable Values


deleteReferenceReturn

deleteReference Test Case:

Input: deleteReferenceRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteReference>
<in0>webapi411835895647962205</in0>
<in1>3</in1>
</urn:deleteReference>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 190


Candidate API Calls
getCandidateById Element:

Output: deleteReferenceResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteReferenceResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getReferencesByCandidate Element:

Operation type: Request-response.


 The endpoint receives a message to get reference(s) associated with any Taleo Business
Edition candidate, and sends back reference IDs associated with the candidate ID.

Input: getReferencesByCandidateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of candidate

Output: getReferencesByCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


array of reference
getReferencesByCandidateReturn
IDs

getReferencesByCandidate Test Case:

Input: getReferencesByCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getReferencesByCandidate>

Taleo Business Edition API Guide Page 191


Candidate API Calls
getCandidateById Element:

<in0>webapi411835895647962205</in0>
<in1>48</in1>
</urn:getReferencesByCandidate>
</soapenv:Body>
</soapenv:Envelope>

Output: getReferencesByCandidateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getReferencesByCandidateResponse xmlns="urn:TBEWebAPI">
<getReferencesByCandidateReturn xmlns="">
<array>
<item>2</item>
<item>1</item>
</array>
</getReferencesByCandidateReturn>
</getReferencesByCandidateResponse>
</soapenv:Body>
</soapenv:Envelope>

getReferenceById Element:

Operation type: Request-response.


 The endpoint receives a message to get reference details by reference ID, and sends a
correlated message of reference information.

Input: getReferenceByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
ID of Reference
in1 Reference ID Yes
Instance

Output: getReferenceByIdResponse

Data Field Name Data Field Type Required Acceptable Values

Taleo Business Edition API Guide Page 192


Candidate API Calls
getCandidateById Element:

getReferenceByIdReturn referenceBean []

getReferenceById Test Case:

Input: getReferenceByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getReferenceById>
<in0>webapi411835895647962205</in0>
<in1>1</in1>
</urn:getReferenceById>
</soapenv:Body>
</soapenv:Envelope>

Output: getReferenceByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getReferenceByIdResponse xmlns="urn:TBEWebAPI">
<getReferenceByIdReturn xmlns="">
<creationDate>2009-09-11T17:17:07.015Z</creationDate>
<flexValues/>
<id>1</id>
<lastUpdated>2009-09-11T17:17:07.015Z</lastUpdated>
<status>Submitted</status>
<candidateId>48</candidateId>
<comments>Candidate's major strengths are selling and buying</comments>
<creator>skarim</creator>
<employer>Nordstroms</employer>
<refEmail>[email protected]</refEmail>
<refName>Sally Store</refName>
<refPhone>948-234-4958</refPhone>
<refTitle>Manager</refTitle>
<relToCandidate>Direct Manager</relToCandidate>
</getReferenceByIdReturn>
</getReferenceByIdResponse>
</soapenv:Body>

Taleo Business Edition API Guide Page 193


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

updateReference Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing reference instance, and sends a
correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the referenceBean (i.e. data is not
appended or upserted). Send all elements back or the field values will be returned NULL.

Input: updateReferenceRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
id *
status *
candidateId *
comments
creator
in1 referenceBean[] *
employer
refEmail
refName *
refPhone
refTitle
relToCandidate

Output: updateReferenceResponse

Data Field Name Data Field Type Required Acceptable Values


updateReferenceReturn

updateReference Test Case:

Input: updateReferenceRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>

Taleo Business Edition API Guide Page 194


Candidate API Calls
getCandidateById Element:

<soapenv:Body>
<urn:updateReference>
<in0>webapi411835895647962205</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<id>2</id>
<status>Submitted</status>
<candidateId>48</candidateId>
<comments>Reference Completed - candidate successful</comments>
<creator>skarim</creator>
<employer>Nordstroms</employer>
<refEmail>[email protected]</refEmail>
<refName>Jason Nord</refName>
<refPhone>829-239-2394</refPhone>
<refTitle>Director</refTitle>
<relToCandidate>Manager's manager</relToCandidate>
</in1>
</urn:updateReference>
</soapenv:Body>
</soapenv:Envelope>

Output: updateReferenceResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateReferenceResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 195


Candidate API Calls
getCandidateById Element:

Requisition API Calls


Requisitions are all of the job openings you want to track in Taleo Business Edition and post on
your careers website.

requisitionBean Definition:

Data Field Name Data Field Type Required Acceptable Values


Requisition’s unique server side ID. Can
be obtained by searching the requisition
id long Read Only
database or by creating a new
requisition.
status String Yes Requisition’s Status name from pick list
title String Yes Requisition’s title
Name of location (from pick list)
location String Yes
assigned to this requisition
duration String No Requisition’s type from pick list
payRange String No Pay range
description String No Requisition’s description
jobCategory String No EEO Job category name from pick list
jobCode String No Job code
numOpen int No Number of openings
openedDate Date No Date when this requisition was opened
filledDate Date No Date when this requisition was filled
creationDate Date Read Only Creation date
lastUpdated Date Read Only Last updated date
flexValues FlexFieldBean[] No Array of flexible (custom) field values

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
fieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
stringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
intValue int No Value of Integer field
doubleValue double No Value of Decimal or Currency field
booleanValue boolean No Value of Check Box field
dateValue Date No Value of Date field

Taleo Business Edition API Guide Page 196


Candidate API Calls
getCandidateById Element:

createRequisition Element:

Operation type: Request-response.


 The endpoint receives a message to create a requisition, and sends a correlated message
of requisition ID.

Input: createRequisitionRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
status *
city
description
duration
jobCategory
jobCode
in1 requisitionBean [] *
location *
numOpen
openedDate
payRange
state
title *
filledDate

Output: createRequisitionResponse

Data Field Name Data Field Type Required Acceptable Values


Provided Requisition
createRequsitionReturn Long Yes
ID

createRequisition Test Case:

Input: createRequisitionRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>

Taleo Business Edition API Guide Page 197


Candidate API Calls
getCandidateById Element:

<soapenv:Body>
<urn:createRequisition>
<in0>webapi-8638387102069848283</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<status>Waiting for Approval</status>
<city>San Francisco</city>
<description>The Human Resources Generalist originates and leads Human Resources
practices and objectives that will provide an employee-oriented, high performance culture
that emphasizes empowerment, quality, productivity and standards, goal attainment, and the
recruitment and ongoing development of a superior workforce. The Human Resources
Generalist coordinates implementation of services, policies, and programs through Human
Resources staff; reports to the Human Resources Director, and assists and advises company
managers about Human Resources issues.</description>
<duration>Full time</duration>
<jobCategory>Professionals</jobCategory>
<jobCode>Level 1</jobCode>
<location>Headquarters</location>
<numOpen>3</numOpen>
<openedDate>2009-06-30T23:01:26.493Z</openedDate>
<payRange>50000 - 75000</payRange>
<state>US-CA</state>
<title>HR Generalist</title>
</in1>
</urn:createRequisition>
</soapenv:Body>
</soapenv:Envelope>

Output: createRequisitionResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createRequisitionResponse xmlns="urn:TBEWebAPI">
<createRequisitionReturn xmlns="">16</createRequisitionReturn>
</createRequisitionResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 198


Candidate API Calls
getCandidateById Element:

createRequisitionTemplate Element:

Operation type: Request-response.


 Templates are the available jobs preloaded in Taleo for users to post easily with
consistency. They are stored in the job library.
 Click on the appropriate Template below to start the process of composing a requisition
The endpoint receives a message to create a requisition template, and sends a
correlated message of requisition ID.

Input: createRequisitionTemplateRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
status *
city
description
duration
jobCategory
jobCode
in1 requisitionBean [] *
location *
numOpen
openedDate
payRange
state
title *
filledDate

Output: createRequisitionTemplateResponse

Data Field Name Data Field Type Required Acceptable Values


Provided
createRequisitionTemplateReturn Long Yes
Requisition ID

createRequisitionTemplate Test Case:

Input: createRequisitionTemplateRequest

Taleo Business Edition API Guide Page 199


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createRequisitionTemplate>
<in0>webapi-8638387102069848283</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<status>Waiting for Approval</status>
<city>San Francisco</city>
<description>The Human Resources manager leads HR Generalists</description>
<duration>Full time</duration>
<jobCategory>Professional</jobCategory>
<jobCode>Level 1</jobCode>
<location>Headquarters</location>
<numOpen>3</numOpen>
<openedDate>2009-06-30T23:01:26.493Z</openedDate>
<payRange>50000 - 75000</payRange>
<state>US-CA</state>
<title>HR Manager</title>
</in1>
</urn:createRequisitionTemplate>
</soapenv:Body>
</soapenv:Envelope>

Output: createRequisitionTemplateResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createRequisitionTemplateResponse xmlns="urn:TBEWebAPI">
<createRequisitionTemplateReturn>20</createRequisitionTemplateReturn>
</createRequisitionTemplateResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 200


Candidate API Calls
getCandidateById Element:

deleteRequisition Element:

Operation type: Request-response.


 The endpoint receives a message to delete a requisition instance, and sends a correlated
message only if error occurred.

Input: deleteRequisitionRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Requisition ID Yes ID of Requisition

Output: deleteRequisitionResponse

Data Field Name Data Field Type Required Acceptable Values


deleteRequisitionReturn

deleteRequisition Test Case:

Input: deleteRequisitionRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteRequisition>
<in0>webapi-8638387102069848283</in0>
<in1>22</in1>
</urn:deleteRequisition>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteRequisitionResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteRequisitionResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>

Taleo Business Edition API Guide Page 201


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

getRequisitionById Element:

Operation type: Request-response.


 The endpoint receives a message to get requisition details by requisition ID, and sends a
correlated message of requisition information.

Input: getRequisitionByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
ID of Requisition
in1 Requisition ID Yes
Instance

Output: getRequisitionByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getRequisitionByIdReturn requisitionBean []

getRequisitionById Test Case:

Input: getRequisitionByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getRequisitionById>
<in0>webapi-8638387102069848283</in0>
<in1>13</in1>
</urn:getRequisitionById>
</soapenv:Body>
</soapenv:Envelope>

Output: getRequisitionByIdResponse

Taleo Business Edition API Guide Page 202


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getRequisitionByIdResponse xmlns="urn:TBEWebAPI">
<getRequisitionByIdReturn xmlns="">
<creationDate>2009-02-25T23:34:37.537Z</creationDate>
<flexValues>
<item>
<fieldName>jobType</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr xsi:nil="true"/>
</item>
<item>
<fieldName>Job Reason</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>Resignation</valueStr>
</item>
<item>
<fieldName>Budgeted</fieldName>
<valueBool xsi:nil="true"/>
<valueDate xsi:nil="true"/>
<valueDbl xsi:nil="true"/>
<valueInt xsi:nil="true"/>
<valueLong xsi:nil="true"/>
<valueStr>Budgeted</valueStr>
</item>
</flexValues>
<id>13</id>
<lastUpdated>2009-02-25T23:34:37.537Z</lastUpdated>
<status>Open</status>
<city>Queens</city>
<description><![CDATA[<p><font face="Arial">DESCRIPTION OF JOB DUTIES:</font></p>
<p><font face="Arial">&middot;&nbsp;&nbsp;&nbsp;&nbsp; Pursue and qualify new leads
from new clients, existing clients, and other Idea offices<br />

Taleo Business Edition API Guide Page 203


Candidate API Calls
getCandidateById Element:

&middot;&nbsp;&nbsp;&nbsp;&nbsp; Sell IT solutions/services from our core offerings to the


clients<br />
&middot;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Build successful client relationships &amp;
manage existing client relationships to ensure client satisfaction and identify new
opportunities within existing projects<br />
&middot;&nbsp;&nbsp;&nbsp;&nbsp; Adhere to established sales and workflow processes<br
/>
&middot;&nbsp;&nbsp;&nbsp;&nbsp; Give capabilities presentations to clients <br />
&middot;&nbsp;&nbsp;&nbsp;&nbsp; Work closely with the Solution Director to draft
proposals and/or statements of work<br />
&middot;&nbsp;&nbsp;&nbsp;&nbsp; Responsible for providing accurate estimates for
budgets and time lines in proposals<br />
&middot;&nbsp;&nbsp;&nbsp;&nbsp; Handle all aspects of pre-engagement activity and the
transition of projects to Project Managers<br />
&middot;&nbsp;&nbsp;&nbsp;&nbsp; Participate and collaborate in all sales meetings<br />
&middot;&nbsp;&nbsp;&nbsp;&nbsp; Provide Weekly updates to Managing Director
</font></p>
<p><font face="Arial">&nbsp;</font></p>
<p><font face="Arial">REQUIRED EXPERIENCE: </font></p>
<p><font face="Arial">&bull; Have demonstrated successful experience identifying, qualifying,
and closing new business opportunities<br />
&bull; Have successful sales experience focusing on commercial and/or federal sales<br />
&bull; Experience successfully marketing and selling professional and IT services/solutions in
one or more of the following areas (Custom Application Development, Data Warehousing,
Security &amp; Infrastructure, Business Intelligence, IT Security, CRM, SAS and/or
Legacy)<br />
&bull; Significant knowledge of and successful experience using IT solutions sales techniques
and models<br />
&bull; Minimum 7 years of business development and solutions sales experience</font></p>
<p><font face="Arial"></font>&nbsp;</p>]]></description>
<duration>FULLTIME</duration>
<filledDate xsi:nil="true"/>
<jobCategory xsi:nil="true"/>
<jobCode>452346</jobCode>
<location>NY Office</location>
<numOpen>4</numOpen>
<openedDate>2009-02-25T00:00:00.000Z</openedDate>
<payRange/>
<state>US-NY</state>
<title>Business Development Manager</title>
</getRequisitionByIdReturn>
</getRequisitionByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 204


Candidate API Calls
getCandidateById Element:

getRequisitionHistory Element:

Operation type: Request-response.


 The endpoint receives a message to get a Requisition transaction history, and sends a
correlated message of transaction history for the specific requisition ID.
 This object is used to fetch a history log entry which reflects a past event or action
related to requisition. History records can only be created by the server, they cannot be
modified or deleted. History log includes server side ID, test describing history record,
complete text of email message (for email events) and creation date.

Input: getRequisitionHistoryRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Requisition ID Yes ID of Requisition

Output: getRequisitionHistoryResponse

Data Field Name Data Field Type Required Acceptable Values


getRequisitionHistoryReturn historyBean []

getRequisitionHistory Test Case:

Input: getRequisitionHistoryRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getRequisitionHistory>
<in0>webapi-8638387102069848283</in0>
<in1>11</in1>
</urn:getRequisitionHistory>
</soapenv:Body>
</soapenv:Envelope>

Output: getRequisitionHistoryResponse

Taleo Business Edition API Guide Page 205


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getRequisitionHistoryResponse xmlns="urn:TBEWebAPI">
<getRequisitionHistoryReturn xmlns="">
<array>
<item>
<creationDate>2009-09-10T20:39:35.573Z</creationDate>
<emailText xsi:nil="true"/>
<id>556</id>
<text>Candidate (id: 48) (id: 48) Alisha Alexandra Smith has been removed from this
requisition</text>
<userName>skarim</userName>
</item>
<item>
<creationDate>2009-09-04T18:36:21.797Z</creationDate>
<emailText xsi:nil="true"/>
<id>532</id>
<text>Candidate (id: 48) (id: 48) Alisha Alexandra Smith added self to this
requisition</text>
<userName xsi:nil="true"/>
</item>
<item>
<creationDate>2009-02-09T23:03:51.623Z</creationDate>
<emailText xsi:nil="true"/>
<id>99</id>
<text>Posted on Careers Website</text>
<userName xsi:nil="true"/>
</item>
<item>
<creationDate>2009-02-09T23:03:51.430Z</creationDate>
<emailText xsi:nil="true"/>
<id>94</id>
<text>Requisition created</text>
<userName>skarim</userName>
</item>
<item>
<creationDate>2009-02-09T23:03:51.430Z</creationDate>
<emailText xsi:nil="true"/>
<id>97</id>
<text>Approver (id: 7) Karim, Sally has been added to this requisition</text>
<userName>skarim</userName>

Taleo Business Edition API Guide Page 206


Candidate API Calls
getCandidateById Element:

</item>
<item>
<creationDate>2009-02-09T23:03:51.430Z</creationDate>
<emailText xsi:nil="true"/>
<id>98</id>
<text>Offer Approver has been added to this requisition</text>
<userName>skarim</userName>
</item>
</array>
</getRequisitionHistoryReturn>
</getRequisitionHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>

postRequisition Element:

Operation type: Request-response.


 The endpoint receives a message to post a specific requisition to a supported posting
location, and sends back a message only if error occurred.
 Please note, requisitions will only be posted if the requisition has been approved (i.e.
status of ‘Open’) and all other requisition data elements have been completed that are
mandatory based on the application UI (i.e. Requisition Owner has been defined).
 Please Note: As each client may be able to configure multiple posting locations and
multiple application form versions, a standard list of ‘posterId’ and ‘formVersion’
variables has not been provided. The easiest way to find these values is to go into the
application and:
o Select a requisition
o Right click the page and select ‘View Source’.
o Search for ‘Requisition Posters:’
o From here you will find a list of appropriate ID values

Input: postRequisitionRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionId String Yes
Login

Taleo Business Edition API Guide Page 207


Candidate API Calls
getCandidateById Element:

requisitionId Long Yes ID of requisition


ID of the posting
location, for example
a specific Taleo
posterId Long Yes
Business Edition
Career Website
(picklist value ID #)
ID of the required
application form to be
formVersion Long Yes used within the
posting location
(picklist value ID #).

Output: postRequisitionResponse

Data Field Name Data Field Type Required Acceptable Values


postRequisitionReturn

Input: postRequisitionRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:postRequisition>
<sessionId>webapi-8638387102069848283</sessionId>
<requisitionId>16</requisitionId>
<posterId>4</posterId>
<formVersion>0</formVersion>
</urn:postRequisition>
</soapenv:Body>
</soapenv:Envelope>

Output: postRequisitionResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>

Taleo Business Edition API Guide Page 208


Candidate API Calls
getCandidateById Element:

<postRequisitionResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

searchRequisition Element:

Operation type: Request-response.


 The endpoint receives a message to query all requisitions based on defined key (field
name) and value (data looking for), and sends a correlated message of Requisition ID
and associated search relevance.
 Relevance is a value between 0 and 100, which reflects how well the account matches
the search criteria
 Map of search parameters always contains:
o key: name of field to search as a string
o value: search parameter as string.
 Format of search value may differ depending on data type of the search field:
 For text, text area, email, URL fields: simple text to be found (case-insensitive) in this
field. Example:
o key=”city”, value=”Francisco” will search for all candidates with ”Francisco” in
“city” field.
 For integer, double, currency: interval between two numbers separated by ‘|’ character.
Either left (from) or right (to) side can be omitted. Example:
o key=”rank”, value=”100|” will search for all candidates with rank value no less
than 100.
o key=”rank”, value=”|200” will search for all candidates with rank value no more
than 200.
o key=”rank”, value=”100|200” will search for all candidates with rank value
between 100 and 200 (inclusive).
 For date fields: interval between two dates in ISO yyyy-MM-dd format, separated by ‘|’
character. Either left (from) or right (to) side can be omitted. Example:
o key=”startDate”, value=”2004-06-01|” will search for all candidates with start
date on or after June 1st 2004.
o key=”startDate”, value=”|2004-08-01” will search for all candidates with start
date on or before August 1st 2004.
o key=”startDate”, value=”2004-06-01|2004-08-01” will search for all candidates
with start date between June 1st 2004 and August 1st 2004 (inclusive).
 For date interval fields: number of days from today to the past. Example:
o key=” addedWithin”, value=”7” will search for all candidates added to the
system within the last week.
 For single pick list: code value or name of selected item. Example:

Taleo Business Edition API Guide Page 209


Candidate API Calls
getCandidateById Element:

o key=”country”, value=”US” will search for all candidates with country field equals
to “United States”.
o key=”status”, value=”available” will search for all candidates in “Available” status.
 For multiple pick list: code values or names of selected items, separated by ‘|’ character.
Example:
o key=”customMultiple”, value=”A1|B2|X5” will search for all candidates with
customMultiple field containing one or more of values: A1, B2, X5.
 For check box fields: “true” if check box must be checked, “false” is unchecked. Example:
o key=” flagged”, value=”true” will search for all candidates “flagged” for the user
currently logged in.
 Search keys names and types can be found in Administration>Customize>Requisition
Fields. They may include both system fields (listed below for convenience) and custom
fields. For custom fields External name is used as key name.

System Search Keys:

Data Field Name Parameter Type Description


Keyword(s) in requisition’s description.
keyword String Identical syntax as used in Taleo browser
interface.
reqId Integer ID of requisition
jobCode String Job Code
title String Requisition’s title
location Pick list Location assigned to requisition
city String City name
state Pick list State/Region
duration Pick list Duration name
payRange String Pay range
openedDate Date Opened date
filledDate Date Filled date
jobCat Pick list EEO job category
status Pick list Requisition’s status name
lastUpdated Date Last updated date
creationDate Date Added to system date
addedWithin Integer Added within N days
updatedWithin Integer Updated within N days
owners Custom Requisition Owners
approvers Custom Requisition Approvers
offerApprs Custom Offer Approvers
viewers Custom Agencies

Taleo Business Edition API Guide Page 210


Candidate API Calls
getCandidateById Element:

Input: searchRequisitionRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
key
in1 Item… Yes
value

Output: searchRequisitionResponse

Data Field Name Data Field Type Required Acceptable Values


searchRequisitionReturn searchResultBean []

searchRequisition Test Case:

Input: searchRequisitionRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:searchRequisition>
<in0>webapi-8638387102069848283</in0>
<in1>
<!--Zero or more repetitions:-->
<item>
<key>location</key>
<value>Headquarters</value>
</item>
<item>
<key>status</key>
<value>Open</value>
</item>
<item>
<key>jobCode</key>
<value>Level 1</value>
</item>
</in1>
</urn:searchRequisition>
</soapenv:Body>

Taleo Business Edition API Guide Page 211


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

Output: searchRequisitionResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<searchRequisitionResponse xmlns="urn:TBEWebAPI">
<searchRequisitionReturn xmlns="">
<array>
<item>
<id>16</id>
<relevance>1.0</relevance>
</item>
</array>
</searchRequisitionReturn>
</searchRequisitionResponse>
</soapenv:Body>
</soapenv:Envelope>

unpostRequisition Element:

Operation type: Request-response.


 The endpoint receives a message to unpost a specific requisition to a posting location,
and sends back a message only if error occurred.
 Please Note: As each client may be able to configure multiple posting locations, a
standard list of ‘posterId’ variables has not been provided. The easiest way to find these
values is to go into the application and:
o Select a requisition
o Right click the page and select ‘View Source’.
o Search for ‘Requisition Posters:’
o From here you will find a list of appropriate ID values of posting locations
(posterId)

Input: unpostRequisitionRequest

Taleo Business Edition API Guide Page 212


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


sessionId
Session ID received at
String Yes
Login

requisitionId
Long Yes ID of requisition

ID of the posting
location, for example
a specific Taleo
posterId Long Yes
Business Edition
Career Website
(picklist value ID #)

Output: unpostRequisitionResponse

Data Field Name Data Field Type Required Acceptable Values


unpostRequisitionReturn

Input: unpostRequisitionRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:unpostRequisition>
<sessionId>webapi-8638387102069848283</sessionId>
<requisitionId>16</requisitionId>
<posterId>1</posterId>
</urn:unpostRequisition>
</soapenv:Body>
</soapenv:Envelope>

Output: unpostRequisitionResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

Taleo Business Edition API Guide Page 213


Candidate API Calls
getCandidateById Element:

<soapenv:Body>
<unpostRequisitionResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

updateRequisition Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing requisition instance, and sends a
correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the requisitionBean (i.e. data is
not appended or upserted). Send all elements back or the field values will be returned
NULL.

Input: updateRequisitionRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
id *
status *
city
description
duration
jobCategory
in1 requisitionBean[] * jobCode
location *
numOpen
openedDate
payRange
state
title *
filledDate

Output: updateRequisitionResponse

Data Field Name Data Field Type Required Acceptable Values


updateRequisitionReturn

Taleo Business Edition API Guide Page 214


Candidate API Calls
getCandidateById Element:

updateRequisition Test Case:

Input: updateRequisitionRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateRequisition>
<in0>webapi-3736131371583618769</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
<item>
</item>
</flexValues>
<id>16</id>
<status>Filled</status>
<city>San Francisco</city>
<description>The Human Resources Generalist originates and leads Human Resources
practices and objectives that will provide an employee-oriented, high performance culture
that emphasizes empowerment, quality, productivity and standards, goal attainment, and the
recruitment and ongoing development of a superior workforce. The Human Resources
Generalist coordinates implementation of services, policies, and programs through Human
Resources staff; reports to the Human Resources Director, and assists and advises company
managers about Human Resources issues.</description>
<duration>Full time</duration>
<jobCategory>Professional</jobCategory>
<jobCode>Level 1</jobCode>
<location>Headquarters</location>
<numOpen>2</numOpen>
<openedDate>2009-06-30T23:01:26.493Z</openedDate>
<payRange>50000 - 75000</payRange>
<state>US-CA</state>
<title>HR Generalist</title>
<filledDate>2009-09-31T23:01:26.493Z</filledDate>
</in1>
</urn:updateRequisition>
</soapenv:Body>
</soapenv:Envelope>

Output: updateRequisitionResponse

Taleo Business Edition API Guide Page 215


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateRequisitionResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Resume API Calls


Resumes are all of the primary CVs associated with Candidates in Taleo Business Edition.

getBinaryResume Element:

Operation type: Request-response.


 The endpoint receives a message to get the primary resume binary attachment
associated with a candidate, and sends back the resume binary resume data.

Input: getBinaryResumeRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of candidate

Output: getBinaryResumeResponse

Data Field Name Data Field Type Required Acceptable Values


getBinaryReturn base64Binary []

getBinaryResume Test Case:

Input: getBinaryResumeRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">

Taleo Business Edition API Guide Page 216


Candidate API Calls
getCandidateById Element:

<soapenv:Header/>
<soapenv:Body>
<urn:getBinaryResume>
<in0>webapi1673199911353581754</in0>
<in1>48</in1>
</urn:getBinaryResume>
</soapenv:Body>
</soapenv:Envelope>

Output: getBinaryResumeResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getBinaryResumeResponse xmlns="urn:TBEWebAPI">
<getBinaryResumeReturn xmlns="">
<array>UEsDBBQABgAIAAAAIQAwySgMcgEAAKUFAAATA ==</array>
</getBinaryResumeReturn>
</getBinaryResumeResponse>
</soapenv:Body>
</soapenv:Envelope>

parseResume Element:

Operation type: Request-response.


 The endpoint receives a message resume binary attachment, and sends back a passed
output of resume data (using third-party provider ResumeMirror)

Input: parseResumeRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 ByteArr Yes base64Binary []

Output: parseResumeResponse

Taleo Business Edition API Guide Page 217


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


parseResumeReturn
ResumeMirror HR-XML
ParseResume Response

parseResume Test Case:

Input: parseResumeRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:parseResume>
<in0>webapi-3736131371583618769</in0>
<in1>
<array>0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAA==</array>
</in1>
</urn:parseResume>
</soapenv:Body>
</soapenv:Envelope>

Output: parseResumeResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<parseResumeResponse xmlns="urn:TBEWebAPI">
<parseResumeReturn xmlns=""><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>
<Resume>
<StructuredXMLResume>
<ContactInfo>
<PersonName>
<FormattedName>Sandy Keagon</FormattedName>
<GivenName>Sandy</GivenName>
<FamilyName>Keagon</FamilyName>
</PersonName>
<ContactMethod>
<Use>personal</Use>

Taleo Business Edition API Guide Page 218


Candidate API Calls
getCandidateById Element:

<Telephone>
<InternationalCountryCode>1</InternationalCountryCode>
<AreaCityCode>604</AreaCityCode>
<SubscriberNumber>7693087</SubscriberNumber>
</Telephone>
<InternetEmailAddress>[email protected]</InternetEmailAddress>
<PostalAddress>
<CountryCode>CA</CountryCode>
<PostalCode>V6B 3M6</PostalCode>
<Region>BC</Region>
<Municipality>Vancouver</Municipality>
<DeliveryAddress>
<AddressLine>1060 Seymour Street</AddressLine>
</DeliveryAddress>
</PostalAddress>
</ContactMethod>
</ContactInfo>
</Resume>]]></parseResumeReturn>
</parseResumeResponse>
</soapenv:Body>
</soapenv:Envelope>

parseResumeIntoCandidate Element:

Operation type: Request-response.


 The endpoint receives a message resume binary attachment and creates a new
candidate with contact information parsed with the original resume appended to the
candidate record, and sends back:
o Candidate ID (either newly created or existing if duplicate)
o Duplicate Value where 0 equals none existing and 1 equals duplicate exists

Input: parseResumeIntoCandidateRequest

Data Field Data Field Required


Acceptable Values
Name Type
in0 String Yes Session ID received at Login
in1 ByteArr Yes base64Binary []
referredBy String No Name of referral source
filename String Yes Name of the resume file including extension.
The following MIME types are acceptable:

Taleo Business Edition API Guide Page 219


Candidate API Calls
getCandidateById Element:

Text = text/plain
html = text/html
RTF = text/richtext
Word = application/msword
DocX =
application/vnd.openxmlformats-
officedocument.wordprocessingml.document
PDF = application/pdf

Output: parseResumeIntoCandidateResponse

Data Field Name Data Field Type Required Acceptable Values


candidateId
parseResumeIntoCandidateReturn dup (duplicate
value)

parseResumeIntoCandidate Test Case:

Input: parseResumeIntoCandidateRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:parseResumeIntoCandidate>
<in0>webapi-3736131371583618769</in0>
<in1>
<array>0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAA==</array>
</in1>
<referredBy>bdonlan</referredBy>
<fileName>resume.doc</fileName>
</urn:parseResumeIntoCandidate>
</soapenv:Body>
</soapenv:Envelope>

Output: parseResumeIntoCandidateResponse

Taleo Business Edition API Guide Page 220


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<parseResumeIntoCandidateResponse xmlns="urn:TBEWebAPI">
<parseResumeIntoCandidateReturn xsi:type="ns1:CandidateInsertResultBean" xmlns=""
xmlns:ns1="urn:TBEWebAPI">
<candidateId>50</candidateId>
<dup>1</dup>
</parseResumeIntoCandidateReturn>
</parseResumeIntoCandidateResponse>
</soapenv:Body>
</soapenv:Envelope>

setBinaryResume Element:

Operation type: Request-response.


 The endpoint receives a message to append a resume attachment to a candidate ID, and
sends a correlated message only if error occurred.

Input: setBinaryResumeRequest

Data Field Required


Data Field Type Acceptable Values
Name
in0 String Yes Session ID received at Login
in1 Candidate ID Yes ID of Candidate
Filename of binary file with defined file
extension. The following MIME types are
acceptable:
Text = text/plain
html = text/html
in2 String Yes RTF = text/richtext
Word = application/msword
DocX =
application/vnd.openxmlformats-
officedocument.wordprocessingml.document
PDF = application/pdf
in3 ByteArr Yes base64Binary []

Taleo Business Edition API Guide Page 221


Candidate API Calls
getCandidateById Element:

Output: setBinaryResumeResponse

Data Field Name Data Field Type Required Acceptable Values


setBinaryResumeReturn

setBinaryResume Test Case:

Input: setBinaryResumeRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:setBinaryResume>
<in0>webapi-3736131371583618769</in0>
<in1>44</in1>
<in2>solidResume.doc</in2>
<in3>
<array>0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAA==</array>
</in3>
</urn:setBinaryResume>
</soapenv:Body>
</soapenv:Envelope>

Output: setBinaryResumeResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<setBinaryResumeResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Search API Calls

Taleo Business Edition API Guide Page 222


Candidate API Calls
getCandidateById Element:

Search API calls are the results of querying of supported entities in Taleo Business Edition. This
object is used to encapsulate the ID of the entity found in Taleo during a search. By using this ID,
a Web API client can get detailed information or perform other operations on that entity. Results
are provided in an array where the ID is provided of the result and a score of relevance.

The following entities are supported for search:


 Account
 Candidate
 Contact
 Employee
 Requisition
 User

Use the search(entityName) call for the appropriate entity you are searching.

searchResultBean Definition:

Data Field Name Data Field Type Required Acceptable Values


id long Read Only ID of entity found in the database
Relevance is a value between 0 and
100, which reflects how well this
relevance Double Read Only
candidate or requisition matches the
search criteria

System-Wide Search Definition:

Map of search parameters always contains:


 key: name of field to search as a string
 value: search parameter as string.
Format of search value may differ depending on data type of the search field:
 For text, text area, email, URL fields: simple text to be found (case-insensitive) in this
field. Example:
o key=”city”, value=”Francisco” will search for all candidates with ”Francisco” in
“city” field.
 For integer, double, currency: interval between two numbers separated by ‘|’ character.
Either left (from) or right (to) side can be omitted. Example:
o key=”rank”, value=”100|” will search for all candidates with rank value no less
than 100.
o key=”rank”, value=”|200” will search for all candidates with rank value no more
than 200.

Taleo Business Edition API Guide Page 223


Candidate API Calls
getCandidateById Element:

o key=”rank”, value=”100|200” will search for all candidates with rank value
between 100 and 200 (inclusive).
 For date fields: interval between two dates in ISO yyyy-MM-dd format, separated by ‘|’
character. Either left (from) or right (to) side can be omitted. Example:
o key=”startDate”, value=”2004-06-01|” will search for all candidates with start
date on or after June 1st 2004.
o key=”startDate”, value=”|2004-08-01” will search for all candidates with start
date on or before August 1st 2004.
o key=”startDate”, value=”2004-06-01|2004-08-01” will search for all candidates
with start date between June 1st 2004 and August 1st 2004 (inclusive).
 For date interval fields: number of days from today to the past. Example:
o key=” addedWithin”, value=”7” will search for all candidates added to the
system within the last week.
 For single pick list: code value or name of selected item. Example:
o key=”country”, value=”United States” will search for all candidates with country
field equals to “United States”.
o key=”status”, value=”available” will search for all candidates in “Available”
status.
 For multiple pick list: code values or names of selected items, separated by ‘|’ character.
Example:
o key=”customMultiple”, value=”A1|B2|X5” will search for all candidates with
customMultiple field containing one or more of values: A1, B2, X5.
 For check box fields: “true” if check box must be checked, “false” is unchecked.
Example:
o key=” flagged”, value=”true” will search for all candidates “flagged” for the user
currently logged in.

Search keys names and types can be found in Administration>Customize>(Entity) Fields. They
may include both system fields and custom fields. For custom fields External name is used as
key name.

System Search Field Definitions:

Data Field Name Data Field Type Required Acceptable Values


addedWithin Integer No Added within N days
creationDate Date No Added to system date
Keyword(s) in description. Identical
keyword String No syntax as used in Taleo browser
interface.
lastUpdated Date No Last updated date
phoneAll String No Any phone number
state Pick list No State/Region
status Pick list No Status name

Taleo Business Edition API Guide Page 224


Candidate API Calls
getCandidateById Element:

updatedWithin Integer No Updated within N days

System API Calls


All system level properties for a Taleo Business Edition client, including modules uses, system
setting values, and system URLs.

getEnabledServices Element:

Operation type: Request-response.


 The endpoint receives a message to get the all the application modules the company
code has turned on, and sends back all system modules configured where:
o 'perform' = Taleo Business Edition Perform
o 'onBoarding' = Taleo Business Edition onBoarding
o 'recruit' = Taleo Business Edition Recruit
o 'backup' = Taleo Business Edition on-Demand BackUp Service
o 'offcp' = Taleo Business Edition OFFCP Compliance Package
o 'tsc' = Taleo Schedule Center for Recruit
o 'tvr'= Taleo Voice Response for Recruit
o 'generic'= Taleo Business Edition Generic Package for Recruit
o 'staffing' = Taleo Business Edition Staffing Package for Recruit
o 'pureDiscovery' = Pure Discovery Advanced Sourcing for Recruit

Input: getEnabledServicesRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login

Output: getEnabledServicesResponse

Data Field Name Data Field Type Required Acceptable Values


String of system
getEnabledServicesReturn
modules

getEnabledServices Test Case:

Taleo Business Edition API Guide Page 225


Candidate API Calls
getCandidateById Element:

Input: getEnabledServicesRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getEnabledServices>
<in0>webapi-8948403736913319968</in0>
</urn:getEnabledServices>
</soapenv:Body>
</soapenv:Envelope>

Output: getEnabledServicesResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getEnabledServicesResponse xmlns="urn:TBEWebAPI">
<getEnabledServicesReturn
xmlns="">,perform,onBoarding,tsc,tvr,generic,staffing,recruit,pureDiscovery,backup,offcp</get
EnabledServicesReturn>
</getEnabledServicesResponse>
</soapenv:Body>
</soapenv:Envelope>

getSystemProps Element:

Operation type: Request-response.


 The endpoint receives a message to get the system props of a company code using valid
session variable, and sends back all system properties configured.
 System-level properties return as string-string map:

Property Name Property Value


HiredStatuses Comma-separated ids of statuses for hired candidates
OpenedStatuses Comma-separated ids of statuses for opened requisitionss
MyViewStatuses Comma-separated ids of statuses for candidates shown on “My View”
page

Taleo Business Edition API Guide Page 226


Candidate API Calls
getCandidateById Element:

PipelineStatuses Comma-separated ids of statuses for candidates shown on “Pipeline”


page

Input: getSystemPropsRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login

Output: getSystemPropsResponse

Data Field Name Data Field Type Required Acceptable Values


Array of System
getSystemPropsReturn
Property Values

getSystemProps Test Case:

Input: getSystemPropsRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getSystemProps>
<in0>webapi8250491874042899515</in0>
</urn:getSystemProps>
</soapenv:Body>
</soapenv:Envelope>

Output: getSystemPropsResponse (truncated)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getSystemPropsResponse xmlns="urn:TBEWebAPI">
<getSystemPropsReturn xmlns="">
<item>
<key xsi:type="xsd:string">BlockedEmailAttachments</key>

Taleo Business Edition API Guide Page 227


Candidate API Calls
getCandidateById Element:

<value xsi:type="xsd:string">*.bat;*.vbs;*.com;*.exe;*.scr</value>
</item>
<key xsi:type="xsd:string">ReqLinkTemplate</key>
<value xsi:type="xsd:string">5</value>
</item>
<item>
<key xsi:type="xsd:string">ApplicationName</key>
<value xsi:type="xsd:string">Taleo Business Edition</value>
</item>
<item>
<key xsi:type="xsd:string">DaysBeforeShutdown</key>
<value xsi:type="xsd:string">30</value>
</item>
<item>
<key xsi:type="xsd:string">msg.c3p0.preferredTestQuery</key>
<value xsi:type="xsd:string">select 1</value>
</item>
<item>
<key xsi:type="xsd:string">c3p0.acquireRetryAttempts</key>
<value xsi:type="xsd:string">30</value>
</item>
<item>
<key xsi:type="xsd:string">msg.dbcp.maxActive</key>
<value xsi:type="xsd:string">20</value>
</item>
<item>
<key xsi:type="xsd:string">msg.dbcp.numTestsPerEvictionRun</key>
<value xsi:type="xsd:string">3</value>
</item>
<item>
<key xsi:type="xsd:string">MaxTransactionTime</key>
<value xsi:type="xsd:string">2</value>
</item>
<item>
<key xsi:type="xsd:string">msg.c3p0.acquireRetryDelay</key>
<value xsi:type="xsd:string">1000</value>
</item>
<item>
<key xsi:type="xsd:string">formDisplayManager.cacheSizeLimit</key>
<value xsi:type="xsd:string">50</value>
</item>
<item>
<key xsi:type="xsd:string">c3p0.initialPoolSize</key>
<value xsi:type="xsd:string">5</value>

Taleo Business Edition API Guide Page 228


Candidate API Calls
getCandidateById Element:

</item>
<item>
<key xsi:type="xsd:string">formDisplayManager.commonFormExpiryTime</key>
<value xsi:type="xsd:string">1200</value>
</item>
<item>
<key xsi:type="xsd:string">msg.c3p0.maxConnectionAge</key>
<value xsi:type="xsd:string">0</value>
</item>
<item>
<key xsi:type="xsd:string">dbcp.testWhileIdle</key>
<value xsi:type="xsd:string">true</value>
</item>
<item>
<key xsi:type="xsd:string">ReqCreateTemplate</key>
<value xsi:type="xsd:string">-1</value>
</item>
<item>
<key xsi:type="xsd:string">ReviewApproverApprovesTemplate</key>
<value xsi:type="xsd:string">40</value>
</item>
<item>
<key xsi:type="xsd:string">msg.c3p0.async</key>
<value xsi:type="xsd:string">true</value>
</item>
<item>
<key xsi:type="xsd:string">OfferApprovedTemplate</key>
<value xsi:type="xsd:string">-1</value>
</item>
<item>
<key xsi:type="xsd:string">sccDocSetClient.segment</key>
<value xsi:type="xsd:string">NA01A</value>
</item>
</getSystemPropsReturn>
</getSystemPropsResponse>
</soapenv:Body>
</soapenv:Envelope>

Task API Calls

Taleo Business Edition API Guide Page 229


Candidate API Calls
getCandidateById Element:

Tasks are workflow tasks stored within a specific entity of Taleo Business Edition. There is a one-
to-many relationship with tasks to entities. Entities include accounts (ACCT), candidates (CAND),
contacts (CTCT), employees (EMPL), requisitions (REQU) and users (WORK).

taskBean Definition:

Data Field Type Required Acceptable Values


Data Field
Name

id long Account’s unique server side ID. Can be


Read Only obtained by searching the accounts’
database or by creating a new account.
status String Yes Account’s Status from pick list
creator String Yes Creator’s login name
entityType String No Type of related entity:
ACCT = accounts
CAND = candidates
CTCT = contacts
EMPL = employees
REQU = requisitions
WORK = users
entityId long No ID of associated entity
subject String Yes Subject of event
priority String Priority (from pick list):
Low
Yes
Normal
High
dueDate Date No Task’s due date
description String No Description
participants ParticipantBean[] Yes Array of events’ participants
creationDate Date Read Only Creation date
lastUpdated Date Read Only Last updated date
flexValues FlexFieldBean[] No Array of flexible (custom) field values

participantBean Definition:

Taleo Business Edition API Guide Page 230


Candidate API Calls
getCandidateById Element:

Data Field
Data Field Type Required Acceptable Values
Name
PersonId long Read Only ID of person (user or contact)
Type of person object: WORK=user,
CTCT=contact. Use appropriate API to
PersonType String Yes
extract actual person object using
person’s ID
ID of event (interview, calendar event, or
EventId long Yes
task)
Type of event object: INTV=interview,
CLDEV=calendar event, TASK=task. Use
EventType String Yes
appropriate API to extract actual event
object using event’s ID
StartDate Date No Event's start date for given participant.
EndDate Date No Event's end date for given participant.

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
FieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
StringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
IntValue int No Value of Integer field
DoubleValue double No Value of Decimal or Currency field
BooleanValue boolean No Value of Check Box field
DateValue Date No Value of Date field

createTask Element:

Operation type: Request-response.


 The endpoint receives a message to create a task, and sends a correlated message of
task ID.

Input: createTaskRequest

Data Field Name Data Field Type Required Acceptable Values

Taleo Business Edition API Guide Page 231


Candidate API Calls
getCandidateById Element:

in0 String Yes Session ID received at


Login
flexValues []
status *
creator *
description
dueDate
entityId
entityType
priority *
taskBean[] subject *
in1 *
participantBean []

assignedTo []
endDate
eventId *
eventType *
personId *
personType *
startDate *

Output: createTaskResponse

Data Field Name Data Field Type Required Acceptable Values


createTaskReturn Long Yes Provided Task ID

createTask Test Case:

Input: createTaskRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createTask>
<in0>webapi411835895647962205</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<status>Not Started</status>
<assignedTo>

Taleo Business Edition API Guide Page 232


Candidate API Calls
getCandidateById Element:

<!--Zero or more repetitions:-->


<item>
<endDate>2009-06-30T23:01:26.493Z</endDate>
<eventId>2</eventId>
<eventType>TASK</eventType>
<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</item>
</assignedTo>
<creator>skarim</creator>
<description>Complete Interview</description>
<dueDate>2009-06-30T23:01:26.493Z</dueDate>
<entityId>48</entityId>
<entityType>CAND</entityType>
<priority>High</priority>
<subject>Interview Schedule</subject>
</in1>
</urn:createTask>
</soapenv:Body>
</soapenv:Envelope>

Output: createTaskResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createTaskResponse xmlns="urn:TBEWebAPI">
<createTaskReturn xmlns="">1</createTaskReturn>
</createTaskResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteTask Element:

Operation type: Request-response.


 The endpoint receives a message to delete a task instance, and sends a correlated
message only if error occurred.

Taleo Business Edition API Guide Page 233


Candidate API Calls
getCandidateById Element:

Input: deleteTaskRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Task ID Yes ID of Task

Output: deleteTaskResponse

Data Field Name Data Field Type Required Acceptable Values


deleteTaskReturn

deleteTask Test Case:

Input: deleteTaskRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:deleteTask>
<in0>webapi411835895647962205</in0>
<in1>4</in1>
</urn:deleteTask>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteTaskResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteTaskResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 234


Candidate API Calls
getCandidateById Element:

getTaskByEntity Element:

Operation type: Request-response.


 The endpoint receives a message to get task(s) associated with any Taleo Business
Edition entity that supports storing/creation of task events, and sends back task IDs
associated with the entity ID.

Input: getTaskByEntityRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
Type of related entity:
ACCT = accounts
CAND = candidates
in1 Long Yes
EMPL = employees
REQU = requisitions
WORK = users
in2 Long Yes ID of associated entity

Output: getTaskByEntityResponse

Data Field Name Data Field Type Required Acceptable Values


getTaskByEntityReturn array of task IDs

getTaskByEntity Test Case:

Input: getTaskByEntityRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getTaskByEntity>
<in0>webapi411835895647962205</in0>
<in1>CAND</in1>
<in2>48</in2>
</urn:getTaskByEntity>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 235


Candidate API Calls
getCandidateById Element:

Output: getTaskByEntityResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getTaskByEntityResponse xmlns="urn:TBEWebAPI">
<getTaskByEntityReturn xmlns="">
<array>
<item>1</item>
<item>2</item>
<item>3</item>
</array>
</getTaskByEntityReturn>
</getTaskByEntityResponse>
</soapenv:Body>
</soapenv:Envelope>

getTaskById Element:

Operation type: Request-response.


 The endpoint receives a message to get task details by task ID, and sends a correlated
message of task information.

Input: getTaskByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Task ID Yes ID of Task Instance

Output: getTaskByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getTaskByIdReturn taskBean []

getTaskById Test Case:

Input: getTaskByIdRequest

Taleo Business Edition API Guide Page 236


Candidate API Calls
getCandidateById Element:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getTaskById>
<in0>webapi411835895647962205</in0>
<in1>1</in1>
</urn:getTaskById>
</soapenv:Body>
</soapenv:Envelope>

Output: getTaskByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getTaskByIdResponse xmlns="urn:TBEWebAPI">
<getTaskByIdReturn xmlns="">
<creationDate>2009-09-11T18:04:08.757Z</creationDate>
<flexValues/>
<id>1</id>
<lastUpdated>2009-09-11T18:04:08.757Z</lastUpdated>
<status>Not Started</status>
<assignedTo>
<item>
<endDate xsi:nil="true"/>
<eventId>1</eventId>
<eventType>TASK</eventType>
<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T23:01:26.493Z</startDate>
</item>
</assignedTo>
<creator xsi:nil="true"/>
<description>Complete Interview</description>
<dueDate>2009-06-30T23:01:26.493Z</dueDate>
<entityId>48</entityId>
<entityType>CAND</entityType>
<priority>High</priority>
<subject>Interview Schedule</subject>
</getTaskByIdReturn>
</getTaskByIdResponse>
</soapenv:Body>

Taleo Business Edition API Guide Page 237


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

getTaskByUser Element:

Operation type: Request-response.


 The endpoint receives a message to get all tasks associated with a user, and sends a
correlated message of task IDs

Input: getTaskByUserRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes User ID
startDate interval
in2 Date Yes
for due items
endDate interval for
in3 Date Yes
due items

Output: getTaskByUserResponse

Data Field Name Data Field Type Required Acceptable Values


getTaskByUserReturn array of task IDs

getTaskByUser Test Case:

Input: getTaskByUserRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getTaskByUser>
<in0>webapi411835895647962205</in0>
<in1>7</in1>
<in2>2009-06-30T23:01:26.493Z</in2>
<in3>2009-08-30T23:01:26.493Z</in3>
</urn:getTaskByUser>
</soapenv:Body>

Taleo Business Edition API Guide Page 238


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

Output: getTaskByUserResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getTaskByUserResponse xmlns="urn:TBEWebAPI">
<getTaskByUserReturn xmlns="">
<array>
<item>1</item>
<item>2</item>
<item>3</item>
</array>
</getTaskByUserReturn>
</getTaskByUserResponse>
</soapenv:Body>
</soapenv:Envelope>

updateTask Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing task event, and sends a
correlated message only if error occurred.
 Please Note: Update requests replace all data fields in the taskBean (i.e. data is not
appended or upserted). Send all elements back or the field values will be returned NULL.

Input: updateTaskRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 taskBean[] * flexValues []
participantBean [] id *
status *
creator *
description
dueDate
entityId

Taleo Business Edition API Guide Page 239


Candidate API Calls
getCandidateById Element:

entityType
priority *
subject *

assignedTo []
endDate
eventId *
eventType *
personId *
personType *
startDate *

Output: updateTaskResponse

Data Field Name Data Field Type Required Acceptable Values


updateTaskReturn

updateTask Test Case:

Input: updateTaskRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateTask>
<in0>webapi411835895647962205</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
</flexValues>
<id>2</id>
<status>Completed</status>
<assignedTo>
<!--Zero or more repetitions:-->
<item>
<eventId>1</eventId>
<eventType>TASK</eventType>
<personId>7</personId>
<personType>WORK</personType>
<startDate>2009-06-30T23:01:26.493Z</startDate>

Taleo Business Edition API Guide Page 240


Candidate API Calls
getCandidateById Element:

</item>
</assignedTo>
<creator>skarim</creator>
<description>Complete Interview</description>
<dueDate>2009-06-30T23:01:26.493Z</dueDate>
<entityId>48</entityId>
<entityType>CAND</entityType>
<priority>High</priority>
<subject>Interview Schedule</subject>
</in1>
</urn:updateTask>
</soapenv:Body>
</soapenv:Envelope>

Output: updateTaskResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateTaskResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

User API Calls


Users are all the people with access to your Taleo Business Edition system including hiring
managers, recruiters, interviewers, staffing agencies, etc.

userBean Definition:

** Picklist values within userBean may be customized/configured. Viewing source within the edit
new user screen within Taleo Business Edition outlines picklist values for a client.

Data Field
Data Field Type Required Acceptable Values
Name
id long Read Only User’s unique server side ID. Can be
obtained by searching the user database

Taleo Business Edition API Guide Page 241


Candidate API Calls
getCandidateById Element:

or by creating a new user.


User’s Status Value as derived from
picklist. View Source on add new user
status String Yes
page within the application to find values
of status Names.
firstName
String No First name

middleInitial
String No Middle name

lastName
String Yes Last name.

title
String No User’s title

Name of location (from pick list) assigned


to this user. View Source on add new user
location String No
page within the application to find values
of location IDs.
manager
String No Login name of user’s manager

phone
String No Phone number

cellPhone
String No Cell phone number

fax
String No Fax phone number

email
String Yes Email address

User’s role:
'A' = Administrator
'M' = Hiring Manager
role String Yes 'R' = Recruiter
'E’ = Employee
'G' = Agency
‘ ‘ = no access
loginName
String Yes User’s login name

timeZoneId String No Local User Time zone ID as derived from

Taleo Business Edition API Guide Page 242


Candidate API Calls
getCandidateById Element:

piclklist:
'MIT' = GMT-11:00
'Pacific/Apia' = GMT-11:00
'Pacific/Honolulu' = GMT-10:00
'America/Anchorage' = GMT-08:00
'America/Los_Angeles' = GMT-07:00
'America/Denver' = GMT-06:00
'America/Phoenix' = GMT-07:00
'America/Tegucigalpa' = GMT-06:00
'America/Winnipeg' = GMT-05:00
'America/Mexico_City' = GMT-05:00
'America/Chicago' = GMT-05:00
'America/Costa_Rica' = GMT-06:00
'America/Indianapolis' = GMT-04:00
'America/New_York' = GMT-04:00
'America/Bogota' = GMT-05:00
'America/Montreal' = GMT-04:00
'America/Santiago' = GMT-04:00
'America/Caracas' = GMT-04:30
'America/Thule' = GMT-03:00
'America/St_Johns' = GMT-02:30
'America/Buenos_Aires' = GMT-03:00
'America/Sao_Paulo' = GMT-03:00
'Atlantic/South_Georgia' = GMT-02:00
'Atlantic/Cape_Verde' = GMT-01:00
'Atlantic/Azores' = GMT-00:00
'Europe/Dublin' = GMT+01:00
'Africa/Casablanca' = GMT-00:00
'Europe/Amsterdam' = GMT+02:00
'Europe/Belgrade' = GMT+02:00
'Europe/Brussels' = GMT+02:00
'Europe/Warsaw' = GMT+02:00
'Africa/Lagos' = GMT+01:00
'Europe/Athens' = GMT+03:00
'Europe/Bucharest' = GMT+03:00
'Africa/Cairo' = GMT+03:00
'Africa/Harare' = GMT+02:00
'Europe/Helsinki' = GMT+03:00
'Asia/Jerusalem' = GMT+03:00
'Asia/Baghdad' = GMT+03:00
'Asia/Kuwait' = GMT+03:00
'Europe/Moscow' = GMT+04:00
'Africa/Nairobi' = GMT+03:00
'Asia/Tehran' = GMT+04:30

Taleo Business Edition API Guide Page 243


Candidate API Calls
getCandidateById Element:

'Asia/Dubai' = GMT+04:00
'Asia/Baku' = GMT+05:00
'Asia/Kabul' = GMT+04:30
'Asia/Yekaterinburg' = GMT+06:00
'Asia/Karachi' = GMT+06:00
'Asia/Calcutta' = GMT+05:30
'Asia/Katmandu' = GMT+05:45
'Asia/Almaty' = GMT+06:00
'Asia/Dhaka' = GMT+07:00
'Asia/Colombo' = GMT+05:30
'Asia/Rangoon' = GMT+06:30
'Asia/Bangkok' = GMT+07:00
'Asia/Krasnoyarsk' = GMT+08:00
'Asia/Hong_Kong' = GMT+08:00
'Asia/Irkutsk' = GMT+09:00
'Asia/Kuala_Lumpur' = GMT+08:00
'Australia/Perth' = GMT+08:00
'Asia/Taipei' = GMT+08:00
'Asia/Tokyo' = GMT+09:00
'Asia/Seoul' = GMT+09:00
'Asia/Yakutsk' = GMT+10:00
'Australia/Adelaide' = GMT+09:30
'Australia/Darwin' = GMT+09:30
'Australia/Brisbane' = GMT+10:00
'Australia/Sydney' = GMT+10:00
'Pacific/Guam' = GMT+10:00
'Australia/Hobart' = GMT+10:00
'Asia/Vladivostok' = GMT+11:00
'Asia/Magadan' = GMT+12:00
'Pacific/Auckland' = GMT+12:00
'Pacific/Fiji' = GMT+12:00
'Pacific/Tongatapu' = GMT+13:00
localeCode String No Locale code as derived from picklist:
'enAU' = English - Australia
'enAT' = English - Austria
'enBE' = English - Belgium
'enCA' = English - Canada
'enFI' = English - Finland
'enFR' = English - France
'enGR' = English - Greece
'enIE' = English - Ireland
'enIT' = English - Italy
'enLU' = English - Luxembourg

Taleo Business Edition API Guide Page 244


Candidate API Calls
getCandidateById Element:

'enNL' = English - Netherlands


'enNZ' = English - New Zealand
'enPT' = English - Portugal
'enGB' = English - United Kingdom
'enUS' selected = English - United States
'frCA' = French - Canada
'deDE' = German - Germany
'esMX' = Spanish - Mexico
'esES' = Spanish - Spain
lastLogin
Date Read Only Last Login

creationDate
Date Read Only Creation date

lastUpdated
Date Read Only Last updated date

flexValues
FlexFieldBean[] No Array of flexible (custom) field values

flexFieldBean Definition:

Data Field
Data Field Type Required Acceptable Values
Name
fieldName String Yes Field name
Value of Text, Email, URL, Pick list, or Text
stringValue String No Area field. For Multiple Pick list use ‘|’ to
separate values.
intValue int No Value of Integer field
doubleValue double No Value of Decimal or Currency field
booleanValue Boolean No Value of Check Box field
dateValue Date No Value of Date field

Taleo Business Edition API Guide Page 245


Candidate API Calls
getCandidateById Element:

createUser Element:

Operation type: Request-response.


 The endpoint receives a message to create a user, and sends a correlated message of
user ID.

Input:createUserRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
status *
cellPhone
email *
fax
firstName
lastName *
localeCode
in1 userBean[] *
location
loginName *
manager
middleInitial
phone
role *
timeZoneId
title

Output: createUserResponse

Data Field Name Data Field Type Required Acceptable Values


createUserReturn Long Yes Provided User ID

createUser Test Case:

Input:createUserRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createUser>

Taleo Business Edition API Guide Page 246


Candidate API Calls
getCandidateById Element:

<in0>webapi-7677111958344909818</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->
<item></item>
</flexValues>
<status>Employee</status>
<cellPhone>638-234-5364</cellPhone>
<email>[email protected]</email>
<fax>384-239-2345</fax>
<firstName>James</firstName>
<lastName>Jason</lastName>
<localeCode>Asia/Taipei</localeCode>
<location>Vancouver</location>
<loginName>JamesJason</loginName>
<manager>skarim</manager>
<middleInitial>J</middleInitial>
<phone>897-238-24854</phone>
<role>A</role>
<timeZoneId>Pacific/Apia</timeZoneId>
<title>Manager</title>
</in1>
</urn:createUser>
</soapenv:Body>
</soapenv:Envelope>

Output:createUserResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createUserResponse xmlns="urn:TBEWebAPI">
<createUserReturn xmlns="">16</createUserReturn>
</createUserResponse>
</soapenv:Body>
</soapenv:Envelope>

createUserWithPermissions Element:

Taleo Business Edition API Guide Page 247


Candidate API Calls
getCandidateById Element:

Operation type: Request-response.


 The endpoint receives a message to create a user with permission attributes, and sends
a correlated message of user ID.
 User permissions fall within the attributesBean where ‘approver’ element defines the
user has permissions to approve requisitions and ‘offerAppr’ element defines the user
has permissions to approve requisition offers to candidates. Both attributes are Boolean
where ‘True’ defines allowable ‘approver’ and ‘offerAppr’ abilities for the user.

Input: createUserWithPermissionsRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
sessionID String Yes
Login
userBean
flexValues []
status *
cellPhone
email *
fax
firstName
lastName *
localeCode
location
userBean[]
userBeanToCreate * loginName *
attributesBean []
manager
middleInitial
phone
role *
timeZoneId
title

attributes
approver (Boolean)
offerAppr (Boolean)

Output: createUserWithPermissions Response

Data Field Name Data Field Type Required Acceptable Values


createUserWithPermissions
Long Yes Provided User ID
Return

createUserWithPermissions Test Case:

Taleo Business Edition API Guide Page 248


Candidate API Calls
getCandidateById Element:

Input: createUserWithPermissions Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:createUserWithPermissions>
<sessionId>webapi-7677111958344909818</sessionId>
<userBeanToCreate>
<flexValues>
<!--Zero or more repetitions:-->
<item></item>
</flexValues>
<status>Employee</status>
<cellPhone>638-234-5364</cellPhone>
<email>[email protected]</email>
<fax>384-239-2345</fax>
<firstName>James</firstName>
<lastName>Jason</lastName>
<localeCode>Asia/Taipei</localeCode>
<location>Vancouver</location>
<loginName>JJ1234</loginName>
<manager>skarim</manager>
<middleInitial>J</middleInitial>
<phone>897-238-24854</phone>
<role>A</role>
<timeZoneId>Pacific/Apia</timeZoneId>
<title>Manager</title>
</userBeanToCreate>
<additionalEntities>
<!--Zero or more repetitions:-->
<item>
<key>offerAppr</key>
<value>True</value>
</item>
<item>
<key>approver</key>
<value>True</value>
</item>
</additionalEntities>
</urn:createUserWithPermissions>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 249


Candidate API Calls
getCandidateById Element:

Output: createUserWithPermissionsResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<createUserWithPermissionsResponse xmlns="urn:TBEWebAPI">
<createUserWithPermissionsReturn xmlns="">18</createUserWithPermissionsReturn>
</createUserWithPermissionsResponse>
</soapenv:Body>
</soapenv:Envelope>

deleteUser Element:

Operation type: Request-response.


 The endpoint receives a message to delete a user, and sends a correlated message only
if error occurred.

Input: deleteUserRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 User ID Yes ID of User

Output: deleteUserResponse

Data Field Name Data Field Type Required Acceptable Values


deleteUserReturn

deleteUser Test Case:

Input: deleteUserRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>

Taleo Business Edition API Guide Page 250


Candidate API Calls
getCandidateById Element:

<soapenv:Body>
<urn:deleteUser>
<in0>webapi-7677111958344909818</in0>
<in1>10</in1>
</urn:deleteUser>
</soapenv:Body>
</soapenv:Envelope>

Output: deleteUserResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<deleteUserResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

getUserById Element:

Operation type: Request-response.


 The endpoint receives a message to get an User details, and sends a correlated message
of User information.

Input: getUserByIdRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 User ID Yes ID of User

Output: getUserByIdResponse

Data Field Name Data Field Type Required Acceptable Values


getUserByIdReturn UserBean []

getUserById Test Case:

Taleo Business Edition API Guide Page 251


Candidate API Calls
getCandidateById Element:

Input: getUserByIdRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getUserById>
<in0>webapi-7677111958344909818</in0>
<in1>18</in1>
</urn:getUserById>
</soapenv:Body>
</soapenv:Envelope>

Output: getUserByIdResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getUserByIdResponse xmlns="urn:TBEWebAPI">
<getUserByIdReturn xmlns="">
<creationDate>2009-09-16T00:19:11.544Z</creationDate>
<flexValues></flexValues>
<id>18</id>
<lastUpdated>2009-09-16T00:19:11.544Z</lastUpdated>
<status>Employee</status>
<cellPhone>638-234-5364</cellPhone>
<email>[email protected]</email>
<fax>384-239-2345</fax>
<firstName>James</firstName>
<lastLogin>2009-09-15T22:41:15.643Z</lastLogin>
<lastName>Jason</lastName>
<localeCode>enUS</localeCode>
<location>Vancouver</location>
<loginName>jj1234</loginName>
<manager>[email protected]</manager>
<middleInitial>J</middleInitial>
<phone>897-238-24854</phone>
<role>A</role>
<timeZoneId>Pacific/Apia</timeZoneId>
<title>Manager</title>
</getUserByIdReturn>

Taleo Business Edition API Guide Page 252


Candidate API Calls
getCandidateById Element:

</getUserByIdResponse>
</soapenv:Body>
</soapenv:Envelope>

getUserHistory Element:

Operation type: Request-response.


 The endpoint receives a message to get a Users system history within Taleo Business
Edition, and sends a correlated message of User history information.
 This object is used to fetch a history log entry which reflects a past event or action
related to Users. History records can only be created by the server, they cannot be
modified or deleted. History log includes server side ID, test describing history record,
complete text of email message (for email events) and creation date.

Input: getUserHistoryRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of User

Output: getUserHistoryResponse

Data Field Name Data Field Type Required Acceptable Values


getUserHistoryReturn historyBean []

getUserHistory Test Case:

Input: getUserHistoryRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getUserHistory>
<in0>webapi-7677111958344909818</in0>
<in1>18</in1>
</urn:getUserHistory>
</soapenv:Body>

Taleo Business Edition API Guide Page 253


Candidate API Calls
getCandidateById Element:

</soapenv:Envelope>

Output: getUserHistoryResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getUserHistoryResponse xmlns="urn:TBEWebAPI">
<getUserHistoryReturn xmlns="">
<array>
<item>
<creationDate>2009-09-16T00:19:11.543Z</creationDate>
<emailText xsi:nil="true"/>
<id>654</id>
<text>User created</text>
<userName>skarim</userName>
</item>
<item>
<creationDate>2009-09-16T00:19:11.543Z</creationDate>
<emailText xsi:nil="true"/>
<id>655</id>
<text>Password reset</text>
<userName>skarim</userName>
</item>
</array>
</getUserHistoryReturn>
</getUserHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>

searchUser Element:

Operation type: Request-response.


 The endpoint receives a message to query all Users based on defined key (field name)
and value (data looking for), and sends a correlated message of User ID and associated
search relevance.
 Relevance is a value between 0 and 100, which reflects how well the account matches
the search criteria

Taleo Business Edition API Guide Page 254


Candidate API Calls
getCandidateById Element:

 Map of search parameters always contains:


o key: name of field to search as a string
o value: search parameter as string.
 Format of search value may differ depending on data type of the search field:
 For text, text area, email, URL fields: simple text to be found (case-insensitive) in this
field. Example:
o key=”city”, value=”Francisco” will search for all candidates with ”Francisco” in
“city” field.
 For integer, double, currency: interval between two numbers separated by ‘|’ character.
Either left (from) or right (to) side can be omitted. Example:
o key=”rank”, value=”100|” will search for all candidates with rank value no less
than 100.
o key=”rank”, value=”|200” will search for all candidates with rank value no more
than 200.
o key=”rank”, value=”100|200” will search for all candidates with rank value
between 100 and 200 (inclusive).
 For date fields: interval between two dates in ISO yyyy-MM-dd format, separated by ‘|’
character. Either left (from) or right (to) side can be omitted. Example:
o key=”startDate”, value=”2004-06-01|” will search for all candidates with start
date on or after June 1st 2004.
o key=”startDate”, value=”|2004-08-01” will search for all candidates with start
date on or before August 1st 2004.
o key=”startDate”, value=”2004-06-01|2004-08-01” will search for all candidates
with start date between June 1st 2004 and August 1st 2004 (inclusive).
 For date interval fields: number of days from today to the past. Example:
o key=” addedWithin”, value=”7” will search for all candidates added to the
system within the last week.
 For single pick list: code value or name of selected item. Example:
o key=”country”, value=”US” will search for all candidates with country field equals
to “United States”.
o key=”status”, value=”available” will search for all candidates in “Available” status.
 For multiple pick list: code values or names of selected items, separated by ‘|’ character.
Example:
o key=”customMultiple”, value=”A1|B2|X5” will search for all candidates with
customMultiple field containing one or more of values: A1, B2, X5.
 For check box fields: “true” if check box must be checked, “false” is unchecked. Example:
o key=” flagged”, value=”true” will search for all candidates “flagged” for the user
currently logged in.
 Search keys names and types can be found in Administration>Customize>User Fields.
They may include both system fields (listed below for convenience) and custom fields.
For custom fields External name is used as key name.

System Search Keys:

Taleo Business Edition API Guide Page 255


Candidate API Calls
getCandidateById Element:

Data Field Name Parameter Type Description


Keyword(s) in user’s profile. Identical
keyword String
syntax as used in Taleo browser interface.
firstName String User’s first name
lastName String User’s last name
title String User’s title
location Pick list Location assigned to user
manager String Login name of manager assigned to user
User’s role: 'A'-admin, 'M'-hiring manager,
role String
'R'-recruiter, 'E'-employee, 'G'-agency
addedWithin Integer Added within N days
updatedWithin Integer Updated within N days

Input: searchUserRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
key
in1 Item… Yes
value

Output: searchUserResponse

Data Field Name Data Field Type Required Acceptable Values


searchUserReturn searchResultBean []

searchUser Test Case:

Input: searchUserRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:searchUser>
<in0>webapi-7677111958344909818</in0>
<in1>
<!--Zero or more repetitions:-->
<item>

Taleo Business Edition API Guide Page 256


Candidate API Calls
getCandidateById Element:

<key>Role</key>
<value>Administrator</value>
</item>
</in1>
</urn:searchUser>
</soapenv:Body>
</soapenv:Envelope>

Output: searchUserResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<searchUserResponse xmlns="urn:TBEWebAPI">
<searchUserReturn xmlns="">
<array>
<item>
<id>7</id>
<relevance>1.0</relevance>
</item>
<item>
<id>18</id>
<relevance>1.0</relevance>
</item>
</array>
</searchUserReturn>
</searchUserResponse>
</soapenv:Body>
</soapenv:Envelope>

updateUser Element:

Operation type: Request-response.


 The endpoint receives a message to update an existing user, and sends a correlated
message only if error occurred.
 Please Note: Update requests replace all data fields in the userBean (i.e. data is not
appended or upserted). Send all elements back or the field values will be returned NULL.

Taleo Business Edition API Guide Page 257


Candidate API Calls
getCandidateById Element:

Input: updateUserRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
flexValues []
status *
id *
cellPhone
email *
fax
firstName
lastName *
in1 userBean[] * localeCode
location
loginName*
manager
middleInitial
phone
role *
timeZoneId
title

Output: updateUserResponse

Data Field Name Data Field Type Required Acceptable Values


updateUserReturn

updateUser Test Case:

Input: updateUserRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:updateUser>
<in0>webapi-7677111958344909818</in0>
<in1>
<flexValues>
<!--Zero or more repetitions:-->

Taleo Business Edition API Guide Page 258


Candidate API Calls
getCandidateById Element:

<item></item>
</flexValues>
<status>Employee</status>
<cellPhone>638-234-5364</cellPhone>
<email>[email protected]</email>
<fax>384-239-2345</fax>
<firstName>James</firstName>
<lastName>Jason</lastName>
<localeCode>Asia/Taipei</localeCode>
<location>Vancouver</location>
<loginName>JamesJason</loginName>
<manager>skarim</manager>
<middleInitial>J</middleInitial>
<phone>897-238-24854</phone>
<role>A</role>
<timeZoneId>Pacific/Apia</timeZoneId>
<title>Manager</title>
</in1>
</urn:updateUser>
</soapenv:Body>
</soapenv:Envelope>

Output: updateUserResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<updateUserResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

User Association Calls


User association are the elements that tie a specific user to a requisition within Taleo Business
Edition system including hiring managers, recruiters, interviewers, staffing agencies, etc.

association Definition:

Taleo Business Edition API Guide Page 259


Candidate API Calls
getCandidateById Element:

Data Field
Data Field Type Required Acceptable Values
Name
sessionId String Yes Session ID obtained at login
requisitionId long Yes Requisition’s ID
Picklist of Association Values:
‘O’ = Owner
association String Yes ‘A’ = approvers (in order)
‘F’ = offer approvers (in order)
‘V’ = agencies
IDs of user associated with given
userId long Yes
requisition.
seqNo int No Sequential number for approvers

getAssociatedUsers Element:

Operation type: Request-response.


 The endpoint receives a message to get a users association within a given requistion,
and sends a correlated message array of User IDs.

Input: getAssociatedUsersRequest

Data Field Name Data Field Type Required Acceptable Values


in0 String Yes Session ID received at Login
in1 Long Yes Requisition ID
Picklist of Association
Values:
‘O’ = Owner
in2 String Yes ‘A’ = approvers (in order)
‘F’ = offer approvers (in
order)
‘V’ = agencies

Output: getAssociatedUsersResponse

Data Field Name Data Field Type Required Acceptable Values


getAssociatedUsersReturn Array of User IDs

Taleo Business Edition API Guide Page 260


Candidate API Calls
getCandidateById Element:

getAssociatedUsers Test Case:

Input: getAssociatedUsersRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:getAssociatedUsers>
<in0>webapi-6686750025617579220</in0>
<in1>15</in1>
<in2>O</in2>
</urn:getAssociatedUsers>
</soapenv:Body>
</soapenv:Envelope>

Output: getAssociatedUsersResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getAssociatedUsersResponse xmlns="urn:TBEWebAPI">
<getAssociatedUsersReturn xmlns="">
<array>
<item>7</item>
</array>
</getAssociatedUsersReturn>
</getAssociatedUsersResponse>
</soapenv:Body>
</soapenv:Envelope>

removeAssociatedUser Element:

Operation type: Request-response.


 The endpoint receives a message to remove an association of a user to a requisition, and
sends a correlated message only if error occurred.

Input: removeAssociatedUserRequest

Taleo Business Edition API Guide Page 261


Candidate API Calls
getCandidateById Element:

Data Field Name Data Field Type Required Acceptable Values


in0
Session ID received at
String Yes
Login

in1
Long Yes ID of Requisition

Picklist of Association
Values:
‘O’ = Owner
‘A’ = approvers (in
in2 String Yes
order)
‘F’ = offer approvers
(in order)
‘V’ = agencies
in3
Long Yes ID of User

Output: removeAssociatedUserResponse

Data Field Name Data Field Type Required Acceptable Values


removeAssociatedUserReturn

removeAssociatedUser Test Case:

Input: removeAssociatedUserRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:removeAssociatedUser>
<in0>webapi-6686750025617579220</in0>
<in1>15</in1>
<in2>O</in2>
<in3>7</in3>
</urn:removeAssociatedUser>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 262


Candidate API Calls
getCandidateById Element:

Output: removeAssociatedUserResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<removeAssociatedUserResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

setAssociatedUser Element:

Operation type: Request-response.


 The endpoint receives a message to set a user’s association to a requisition, and sends a
correlated message only if error occurred.

Input: setAssociatedUserRequest

Data Field Name Data Field Type Required Acceptable Values


Session ID received at
in0 String Yes
Login
in1 Long Yes ID of requisition
Picklist of Association
Values:
‘O’ = Owner
‘A’ = approvers (in
in2 String Yes
order)
‘F’ = offer approvers
(in order)
‘V’ = agencies
in3 Long Yes ID of User
Sequence Number of
user to association
in4 String No value (i.e. first
approver = 1, second
approver = 2, etc.)

Output: setAssociatedUserResponse

Data Field Name Data Field Type Required Acceptable Values

Taleo Business Edition API Guide Page 263


Candidate API Calls
getCandidateById Element:

setAssociatedUserReturn

setAssociatedUser Test Case:

Input: setAssociatedUserRequest

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:TBEWebAPI">
<soapenv:Header/>
<soapenv:Body>
<urn:setAssociatedUser>
<in0>webapi-6686750025617579220</in0>
<in1>15</in1>
<in2>O</in2>
<in3>7</in3>
<in4>1</in4>
</urn:setAssociatedUser>
</soapenv:Body>
</soapenv:Envelope>

Output: setAssociatedUserResponse

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<setAssociatedUserResponse xmlns="urn:TBEWebAPI"/>
</soapenv:Body>
</soapenv:Envelope>

Taleo Business Edition API Guide Page 264

You might also like