Service Directory > v31.2 > Student_Recruiting > Get_Search_Service_Definitions
 

Operation: Get_Search_Service_Definitions

Get Search Service Definitions by Name or reference, or return all Search Service Definitions if no criteria is specified.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Search_Service_Definitions_Request

Get Search Service Definitions Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Search_Service_Definition_Request_References  [0..1]  Search Service Definition Request References   
Request_Criteria [Choice]   Search_Service_Definition_Request_Criteria  [0..1]  Search Service Definition Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter for Search Service Definition 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Search_Service_Definitions_Response

Get Search Service Definitions Response for Web Service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Search_Service_Definition_Request_References  [0..1]  Search Service Definition Request References for Web Service   
Request_Criteria  Search_Service_Definition_Request_Criteria  [0..1]  Search Service Definition Request Criteria   
Response_Filter  Response_Filter  [0..1]  Search Service Definition Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Search Service Definition Response Results   
Response_Data  Search_Service_Definition_Response_Data  [0..1]  Search Service Definition Response Data   
top
 

Search_Service_Definition_Request_References

part of: Get_Search_Service_Definitions_Request, Get_Search_Service_Definitions_Response
Search Service Definition Request References
 
Parameter name Type/Value Cardinality Description Validations
Search_Service_Definition_Reference  Search_Service_DefinitionObject  [1..*]  Search Service Definition Request Reference for Web Service   
top
 

Search_Service_DefinitionObject

part of: Search_Service_Definition_Request_References, Search_Service_Definition
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Search_Service_DefinitionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Search_Service_DefinitionObjectID

part of: Search_Service_DefinitionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Search_Service_Definition_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Search_Service_Definition_Request_Criteria

part of: Get_Search_Service_Definitions_Request, Get_Search_Service_Definitions_Response
Get Search Service Definitions
 
Parameter name Type/Value Cardinality Description Validations
Search_Service_Definition_Name  string  [0..1]  Search Service Definition Name for Web Service   
top
 

Response_Filter

part of: Get_Search_Service_Definitions_Request, Get_Search_Service_Definitions_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Search_Service_Definitions_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Search_Service_Definition_Response_Data

part of: Get_Search_Service_Definitions_Response
Get Search Service Definitions Response for Web Service
 
Parameter name Type/Value Cardinality Description Validations
Search_Service_Definition  Search_Service_Definition  [0..*]  Search Service Definition for Web Service   
top
 

Search_Service_Definition

part of: Search_Service_Definition_Response_Data
Search Service Definition Response Data for Web Service
 
Parameter name Type/Value Cardinality Description Validations
Search_Service_Definition_Reference  Search_Service_DefinitionObject  [0..1]  Search Service Definition Reference for Web Service   
Search_Service_Definition_Data  Search_Service_Definition_Data  [0..1]  Search Service Definition Data for Web Services   
top
 

Search_Service_Definition_Data

part of: Search_Service_Definition
Search Service Definition for Web Service
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Search Service Definition   
Name  string  [1..1]  Search Service Definition Name for Search Service Definition Web Service 
Validation Description
Enter a Name that isn't already in use.   
 
Student_Recruiting_Campaign_Reference  Student_Recruiting_CampaignObject  [1..1]  Student Recruiting Campaign Reference for Search Service Definition Web Service   
Search_Service_Reference  Search_ServiceObject  [1..1]  Search Service Reference for Search Service Definition Web Service   
Date_of_Search  date  [0..1]  Date of Search for Search Service Definition Web Service   
Search_Identifier  string  [0..1]  Search Service Definition Identifier for Search Service Definition Web Service   
Description  string  [0..1]  Search Service Definition Description for Web Service   
top
 

Student_Recruiting_CampaignObject

part of: Search_Service_Definition_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Student_Recruiting_CampaignObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Recruiting_CampaignObjectID

part of: Student_Recruiting_CampaignObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Student_Recruiting_Campaign_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Search_ServiceObject

part of: Search_Service_Definition_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Search_ServiceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Search_ServiceObjectID

part of: Search_ServiceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Search_Service_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Search_Service_DefinitionReferenceEnumeration

part of: Search_Service_DefinitionObjectID
Base Type
string
top
 

Student_Recruiting_CampaignReferenceEnumeration

part of: Student_Recruiting_CampaignObjectID
Base Type
string
top
 

Search_ServiceReferenceEnumeration

part of: Search_ServiceObjectID
Base Type
string
top