Service Directory > v32.1 > Staffing > Get_Student_Employment_Eligibility_Rule_Set
 

Operation: Get_Student_Employment_Eligibility_Rule_Set

Get Student Employment Eligibility Rule Set Data


@ - 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_Student_Employment_Eligibility_Rule_Set_Request

Container for Get Student Employment Eligibility Rule Sets Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Employment_Eligibility_Rule_Set_Request_References  [0..1]  Reference Student Employment Eligibility Rule Set Request   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Student_Employment_Eligibility_Rule_Set_Response_Group  [0..1]  Reference Student Employment Eligibility Rule Set Group   
top
 

Response Element: Get_Student_Employment_Eligibility_Rule_Set_Response

Container for Get Student Employment Eligibility Rule Sets Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Student_Employment_Eligibility_Rule_Set_Request_References  [0..1]  Reference Student Employment Eligibility Rule Set Request   
Response_Filter  Response_Filter  [0..1]  Reference Student Employment Eligibility Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Student_Employment_Eligibility_Rule_Set_Response_Group  [0..1]  Reference Student Employment Eligibility Response Group   
Response_Results  Response_Results  [0..1]  Response Result   
Response_Data  Student_Employment_Eligibility_Rule_Set_Response_Data  [0..1]  Reference Student Employment Eligibility Rule Data Element   
top
 

Student_Employment_Eligibility_Rule_Set_Request_References

part of: Get_Student_Employment_Eligibility_Rule_Set_Request, Get_Student_Employment_Eligibility_Rule_Set_Response
Reference Student Employment Eligibility Rule Set Request
 
Parameter name Type/Value Cardinality Description Validations
Student_Employment_Eligibility_Rule_Set_Request_Reference  Student_Employment_Eligibility_Rule_SetObject  [1..*]  Reference Student Employment Eligibility Rule Set Request   
top
 

Student_Employment_Eligibility_Rule_SetObject

part of: Student_Employment_Eligibility_Rule_Set_Request_References, Student_Employment_Eligibility_Rule_Set
 
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_Employment_Eligibility_Rule_SetObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Student_Employment_Eligibility_Rule_SetObjectID

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

Response_Filter

part of: Get_Student_Employment_Eligibility_Rule_Set_Request, Get_Student_Employment_Eligibility_Rule_Set_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
 

Student_Employment_Eligibility_Rule_Set_Response_Group

part of: Get_Student_Employment_Eligibility_Rule_Set_Request, Get_Student_Employment_Eligibility_Rule_Set_Response
Container for Student Employment Eligibility Rule Set Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Student_Employment_Eligibility_Rule_Set_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
 

Student_Employment_Eligibility_Rule_Set_Response_Data

part of: Get_Student_Employment_Eligibility_Rule_Set_Response
Container Student Employment Eligibility Rule Set Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Employment_Eligibility_Rule_Set  Student_Employment_Eligibility_Rule_Set  [0..*]  Student Employment Eligibility Rule Set Reference   
top
 

Student_Employment_Eligibility_Rule_Set

part of: Student_Employment_Eligibility_Rule_Set_Response_Data
Container for Student Employment Eligibility Rule Set Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Employment_Eligibility_Rule_Set_Reference  Student_Employment_Eligibility_Rule_SetObject  [0..1]  Student Employment Eligibility Rule Set Reference   
Student_Employment_Eligibility_Rule_Set_Data  Student_Employment_Eligibility_Rule_Set_Data  [0..*]  Container for Put Student Employment Eligibility Rule Set Response 
Validation Description
Cannot add more than 20 Condition Rules   
 
top
 

Student_Employment_Eligibility_Rule_Set_Data

part of: Student_Employment_Eligibility_Rule_Set
Container for Put Student Employment Eligibility Rule Set Response
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Student Employment Eligibility Rule Set ID   
Student_Employment_Eligibility_Rule_Set_Name  string  [1..1]  Student Employment Eligibility Rule Set Name   
Student_Employment_Eligibility_Rule_Set_Description  string  [0..1]  Student Employment Eligibility Rule Set Description   
Inactive  boolean  [0..1]  Inactive   
Job_Profile_Reference  Job_ProfileObject  [0..*]  Job Profile Reference   
Job_Family_Reference  Job_FamilyObject  [0..*]  Reference element representing a unique instance of Job Family.   
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level Reference   
Academic_Period_Reference  Academic_PeriodObject  [0..*]  Academic Period Reference   
Academic_Period_Type_Reference  Academic_Period_TypeObject  [0..*]  Reference for Academic Period Types   
Student_Employment_Eligibility_Rule_Subedit_Data  Student_Employment_Eligibility_Rule_Subedit_Data  [1..*]  Container for Student Employment Eligibility Rule Subedit Data   
Validation Description
Cannot add more than 20 Condition Rules   
top
 

Job_ProfileObject

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

Job_ProfileObjectID

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

Job_FamilyObject

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

Job_FamilyObjectID

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

Academic_LevelObject

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

Academic_LevelObjectID

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

Academic_PeriodObject

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

Academic_PeriodObjectID

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

Academic_Period_TypeObject

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

Academic_Period_TypeObjectID

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

Student_Employment_Eligibility_Rule_Subedit_Data

part of: Student_Employment_Eligibility_Rule_Set_Data
Container for Student Employment Eligibility Rule Subedit Data
 
Parameter name Type/Value Cardinality Description Validations
Condition_Rule_Reference  Condition_RuleObject  [1..1]  Condition Rule Reference   
Student_Employment_Eligibility_Rule_Reference  string  [0..1]  Student Employment Eligibility Rule ID   
Reason_for_Ineligibility  string  [1..1]  Specifies the Reason for Ineligibility   
Critical_Severity  boolean  [0..1]  Severity of the Condition Rule   
top
 

Condition_RuleObject

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

Condition_RuleObjectID

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

Student_Employment_Eligibility_Rule_SetReferenceEnumeration

part of: Student_Employment_Eligibility_Rule_SetObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Job_FamilyReferenceEnumeration

part of: Job_FamilyObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Academic_Period_TypeReferenceEnumeration

part of: Academic_Period_TypeObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top