Service Directory > v32.1 > Student_Records > Get_Registration_Restriction_Overrides_for_Student
 

Operation: Get_Registration_Restriction_Overrides_for_Student

Get Registration Restriction Overrides for Student web service


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

Get Registration Restrictions for Student Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Registration_Restrictions_for_Student_Request_Criteria  [0..1]  Registration Restrictions for Student Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Registration_Restriction_Overrides_for_Student_Response

Get Registration Restrictions for Student Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Registration_Restrictions_for_Student_Request_Criteria  [1..1]  Registration Restrictions for Student Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Registration_Restrictions_for_Student_Response_Data  [0..1]  Registration Restrictions for Student Response Data   
top
 

Registration_Restrictions_for_Student_Request_Criteria

part of: Get_Registration_Restriction_Overrides_for_Student_Response, Get_Registration_Restriction_Overrides_for_Student_Request
Registration Restrictions for Student Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Academic_Records_Reference  Academic_RecordObject  [1..*]  Academic Records Secured   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period   
top
 

Academic_RecordObject

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

Academic_RecordObjectID

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

Response_Filter

part of: Get_Registration_Restriction_Overrides_for_Student_Response, Get_Registration_Restriction_Overrides_for_Student_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
 

Response_Results

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

Registration_Restrictions_for_Student_Response_Data

part of: Get_Registration_Restriction_Overrides_for_Student_Response
Registration Restrictions for Student Response Data
 
Parameter name Type/Value Cardinality Description Validations
Registration_Restrictions_for_Student  Registration_Restrictions_for_Student  [0..*]  Registration Restrictions for Student   
top
 

Registration_Restrictions_for_Student

part of: Registration_Restrictions_for_Student_Response_Data
Registration Restrictions for Student
 
Parameter name Type/Value Cardinality Description Validations
Registration_Restrictions_for_Student_Reference  Registration_Restriction_Override_Data  [0..1]  Registration Restriction Override Data 
Validation Description
You can only submit one of the following as the student registration restriction: [VALID RESTRICTIONS]   
You can't submit the same registration restriction more than once for the student in the same period.   
You must submit a grading scheme when Enrollment Access is the student registration restriction.   
You can only submit a grading scheme when Enrollment Access is the student registration restriction.   
You must submit an eligibility rule when Eligibility is the student registration restriction.   
You can only submit an eligibility rule when Eligibility is the student registration restriction.   
 
top
 

Registration_Restriction_Override_Data

part of: Registration_Restrictions_for_Student
Registration Restriction Override Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Registration_Restriction_Reference  Student_Registration_RestrictionObject  [1..1]  Student Registration Restriction   
Student_Grading_Scheme_Reference  Student_Grading_SchemeObject  [0..1]  Student Grading Scheme   
Student_Hold_Reference  Student_Hold_Type__All_Object  [0..*]  Student Hold   
Student_Eligibility_Rules_Reference  Student_Eligibility_RuleObject  [0..*]  Student Eligibility Rule   
Enrollment_Unit_Limit_Rule_Maximum_Units  decimal (8, 2) >0   [0..1]  Enrollment Unit Limit Rule Maximum Units   
Registration_Restriction_Overridable_Data  Registration_Restriction_Overridable_Data  [0..*]  Registration Restriction Overridable Data 
Validation Description
You can submit either the course or the course section, not both.   
 
Validation Description
You can only submit one of the following as the student registration restriction: [VALID RESTRICTIONS]   
You can't submit the same registration restriction more than once for the student in the same period.   
You must submit a grading scheme when Enrollment Access is the student registration restriction.   
You can only submit a grading scheme when Enrollment Access is the student registration restriction.   
You must submit an eligibility rule when Eligibility is the student registration restriction.   
You can only submit an eligibility rule when Eligibility is the student registration restriction.   
top
 

Student_Registration_RestrictionObject

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

Student_Registration_RestrictionObjectID

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

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

Student_Grading_SchemeObjectID

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

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

Student_Hold_Type__All_ObjectID

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

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

Student_Eligibility_RuleObjectID

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

Registration_Restriction_Overridable_Data

part of: Registration_Restriction_Override_Data
Registration Restriction Overridable Data
 
Parameter name Type/Value Cardinality Description Validations
Course_Definition_Reference  Course_DefinitionObject  [0..1]  Course Definition Reference   
Course_Section_Definition_Reference  Course_Section_DefinitionObject  [0..*]  Course Section Definition   
Validation Description
You can submit either the course or the course section, not both.   
top
 

Course_DefinitionObject

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

Course_DefinitionObjectID

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

Course_Section_DefinitionObject

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

Course_Section_DefinitionObjectID

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

part of: Academic_RecordObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Student_Registration_RestrictionReferenceEnumeration

part of: Student_Registration_RestrictionObjectID
Base Type
string
top
 

Student_Grading_SchemeReferenceEnumeration

part of: Student_Grading_SchemeObjectID
Base Type
string
top
 

Student_Hold_Type__All_ReferenceEnumeration

part of: Student_Hold_Type__All_ObjectID
Base Type
string
top
 

Student_Eligibility_RuleReferenceEnumeration

part of: Student_Eligibility_RuleObjectID
Base Type
string
top
 

Course_DefinitionReferenceEnumeration

part of: Course_DefinitionObjectID
Base Type
string
top
 

Course_Section_DefinitionReferenceEnumeration

part of: Course_Section_DefinitionObjectID
Base Type
string
top