Service Directory > v31.2 > Recruiting > Get_Recruiting_Self-Schedule_Calendar_Types
 

Operation: Get_Recruiting_Self-Schedule_Calendar_Types

Web service operation to retrieve Recruiting Self-Schedule Calendar Types.


@ - 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_Recruiting_Self-Schedule_Calendar_Types_Request

Element containing the request to retrieve Recruiting Self-Schedule Calendar Type(s).
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Recruiting_Self-Schedule_Calendar_Type_Request_References  [0..1]  Element containing references to Recruiting Self-Schedule Calendar Types to retrieve.   
Request_Criteria [Choice]   Recruiting_Self-Schedule_Calendar_Type_Request_Criteria  [0..1]  Element containing filtering logic for the Recruiting Self-Schedule Calendar Types.   
Response_Filter  Response_Filter  [0..1]  Element used to filter the response. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Recruiting_Self-Schedule_Calendar_Type_Response_Group  [0..1]  Element containing Recruiting Self-Schedule Calendar Type response grouping options.   
top
 

Response Element: Get_Recruiting_Self-Schedule_Calendar_Types_Response

Element containing the Recruiting Self-Schedule Calendar Type(s) retrieved by the web service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Recruiting_Self-Schedule_Calendar_Type_Request_References  [0..1]  Element containing references to Recruiting Self-Schedule Calendar Types to retrieve.   
Request_Criteria  Recruiting_Self-Schedule_Calendar_Type_Request_Criteria  [0..1]  Element containing filtering logic for the Recruiting Self-Schedule Calendar Types.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Recruiting_Self-Schedule_Calendar_Type_Response_Group  [0..1]  Element containing Recruiting Self-Schedule Calendar Type response grouping options.   
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Recruiting_Self-Schedule_Calendar_Type_Response_Data  [0..1]  Element containing data for the Recruiting Self-Schedule Calendar Type.   
top
 

Recruiting_Self-Schedule_Calendar_Type_Request_References

part of: Get_Recruiting_Self-Schedule_Calendar_Types_Response, Get_Recruiting_Self-Schedule_Calendar_Types_Request
Element containing references to Recruiting Self-Schedule Calendar Types to retrieve.
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Self-Schedule_Calendar_Type_Reference  Recruiting_Self-Schedule_Calendar_TypeObject  [1..*]  References to Recruiting Self-Schedule Calendar Types to retrieve.   
top
 

Recruiting_Self-Schedule_Calendar_TypeObject

part of: Recruiting_Self-Schedule_Calendar_Type_Request_References, Recruiting_Self-Schedule_Calendar_Type
 
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  Recruiting_Self-Schedule_Calendar_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Recruiting_Self-Schedule_Calendar_TypeObjectID

part of: Recruiting_Self-Schedule_Calendar_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Recruiting_Self-Schedule_Calendar_Type_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
 

Recruiting_Self-Schedule_Calendar_Type_Request_Criteria

part of: Get_Recruiting_Self-Schedule_Calendar_Types_Response, Get_Recruiting_Self-Schedule_Calendar_Types_Request
Element containing filtering logic for the Recruiting Self-Schedule Calendar Types.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Recruiting_Self-Schedule_Calendar_Types_Response, Get_Recruiting_Self-Schedule_Calendar_Types_Request
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
 

Recruiting_Self-Schedule_Calendar_Type_Response_Group

part of: Get_Recruiting_Self-Schedule_Calendar_Types_Response, Get_Recruiting_Self-Schedule_Calendar_Types_Request
Element containing Recruiting Self-Schedule Calendar Type response grouping options.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

part of: Get_Recruiting_Self-Schedule_Calendar_Types_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
 

Recruiting_Self-Schedule_Calendar_Type_Response_Data

part of: Get_Recruiting_Self-Schedule_Calendar_Types_Response
Element containing data for the Recruiting Self-Schedule Calendar Type.
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Self-Schedule_Calendar_Type  Recruiting_Self-Schedule_Calendar_Type  [0..*]  Element containing data for the Recruiting Self-Schedule Calendar Type.   
top
 

Recruiting_Self-Schedule_Calendar_Type

part of: Recruiting_Self-Schedule_Calendar_Type_Response_Data
Element containing data for the Recruiting Self-Schedule Calendar Type.
 
Parameter name Type/Value Cardinality Description Validations
Recruiting_Self-Schedule_Calendar_Type_Reference  Recruiting_Self-Schedule_Calendar_TypeObject  [0..1]  A unique identifier used to reference a Recruiting Self-Schedule Calendar Type.   
Recruiting_Self-Schedule_Calendar_Type_Data  Recruiting_Self-Schedule_Calendar_Type_Data  [0..1]  Element containing data for the Recruiting Self-Schedule Calendar Type.   
top
 

Recruiting_Self-Schedule_Calendar_Type_Data

part of: Recruiting_Self-Schedule_Calendar_Type
Element containing data for the Recruiting Self-Schedule Calendar Type.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A unique identifier used to reference a Recruiting Self-Schedule Calendar Type.   
Order  string (6)   [0..1]  The order for the Recruiting Self-Schedule Calendar Type.   
Calendar_Type_Name  string  [1..1]  The name for the Recruiting Self-Schedule Calendar Type. 
Validation Description
Enter another Calendar Type Name because [Name] is already in use.   
 
Maps_to_Recruiting_Stage_Reference  Recruiting_Stage__Workday_Owned_Object  [1..1]  The recruiting stage mapped to by the Recruiting Self-Schedule Calendar Type. 
Validation Description
[Stage] is not a valid Maps to Recruiting Stage.   
You can't change the Maps to Recruiting Stage because the calendar type is in use.   
 
Candidate_Self-Schedule_Task_Message  RichText  [1..1]  The message to display on the candidate self-schedule task.   
Candidate_Message_When_No_Time_Slots_are_Available  RichText  [1..1]  The message that displays to a candidates when they access the self-schedule task and no time slots are available.   
Candidate_Message_When_No_Dates_or_Times_Work_for_Candidate  RichText  [1..1]  The message that displays to a candidates when they access the self-schedule task and click the No Dates or Times Work for Me button.   
Inactive  boolean  [0..1]  A boolean flag indicating that the Recruiting Self-Schedule Calendar Type is inactive.   
top
 

Recruiting_Stage__Workday_Owned_Object

part of: Recruiting_Self-Schedule_Calendar_Type_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  Recruiting_Stage__Workday_Owned_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Recruiting_Stage__Workday_Owned_ObjectID

part of: Recruiting_Stage__Workday_Owned_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Recruiting_Stage_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
 

Recruiting_Self-Schedule_Calendar_TypeReferenceEnumeration

part of: Recruiting_Self-Schedule_Calendar_TypeObjectID
Base Type
string
top
 

Recruiting_Stage__Workday_Owned_ReferenceEnumeration

part of: Recruiting_Stage__Workday_Owned_ObjectID
Base Type
string
top
 

RichText

part of: Recruiting_Self-Schedule_Calendar_Type_Data, Recruiting_Self-Schedule_Calendar_Type_Data, Recruiting_Self-Schedule_Calendar_Type_Data
Base Type
string
top