Service Directory > v31.2 > Student_Records > Get_Scheduled_Assessments
 

Operation: Get_Scheduled_Assessments

Retrieves Scheduled Assessments by reference, or returns all Scheduled Assessments if no reference 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_Scheduled_Assessments_Request

Get Scheduled Assessment Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Scheduled_Assessment_Request_References  [0..*]  Scheduled Assessment Request References element   
Request_Criteria  Scheduled_Assessment_Request_Criteria  [0..*]  Scheduled Assessment Request Criteria element   
Response_Filter  Response_Filter  [0..*]  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. 
 
top
 

Response Element: Get_Scheduled_Assessments_Response

Get Scheduled Assessments Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Scheduled_Assessment_Request_References  [0..*]  Scheduled Assessment Request References element   
Request_Criteria  Scheduled_Assessment_Request_Criteria  [0..*]  Scheduled Assessment Request Criteria element   
Response_Filter  Response_Filter  [0..*]  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_Results  Response_Results  [0..*]  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  Scheduled_Assessment_Response_Data  [0..*]  Scheduled Assessment Response Data element   
top
 

Scheduled_Assessment_Request_References

part of: Get_Scheduled_Assessments_Request, Get_Scheduled_Assessments_Response
Scheduled Assessment Request References element
 
Parameter name Type/Value Cardinality Description Validations
Scheduled_Assessment_Reference  Scheduled_AssessmentObject  [0..*]  Scheduled Assessment Request References   
top
 

Scheduled_AssessmentObject

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

Scheduled_AssessmentObjectID

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

Scheduled_Assessment_Request_Criteria

part of: Get_Scheduled_Assessments_Request, Get_Scheduled_Assessments_Response
Scheduled Assessment Request Criteria element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Scheduled_Assessments_Request, Get_Scheduled_Assessments_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_Scheduled_Assessments_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
 

Scheduled_Assessment_Response_Data

part of: Get_Scheduled_Assessments_Response
Get Scheduled Assessments Response element
 
Parameter name Type/Value Cardinality Description Validations
Scheduled_Assessment  Scheduled_Assessment  [0..*]  Scheduled Assessment element   
top
 

Scheduled_Assessment

part of: Scheduled_Assessment_Response_Data
Scheduled Assessment element
 
Parameter name Type/Value Cardinality Description Validations
Scheduled_Assessment_Reference  Scheduled_AssessmentObject  [0..1]  Scheduled Assessment instance   
Scheduled_Assessment_Data  Scheduled_Assessment_Data  [0..1]  Scheduled Assessment Data element 
Validation Description
Location must have a location usage of Instructional.   
Assessment start time must be before end time.   
Assessment Date must be after Course Section Start Date.   
Course Assessment Type must be active.   
Location must be active.   
 
top
 

Scheduled_Assessment_Data

part of: Scheduled_Assessment
Scheduled Assessment Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Scheduled Assessment Reference ID   
Course_Section_Reference  Course_Section_DefinitionObject  [1..1]  Reference to Student Course Section instance 
Validation Description
Course Section cannot be changed for a Scheduled Assessment edit.   
 
Course_Assessment_Type_Reference  Course_Assessment_TypeObject  [1..1]  Reference to Course Assessment Type instance   
Course_Delivery_Mode_Reference  Delivery_ModeObject  [0..1]  Reference to Course Delivery Mode instance   
Date  date  [1..1]  Scheduled Assessment Date   
Start_Time  time  [1..1]  Scheduled Assessment Start Time   
End_Time  time  [1..1]  Scheduled Assessment End Time   
Location_Reference  LocationObject  [0..*]  Reference to Location   
Validation Description
Location must have a location usage of Instructional.   
Assessment start time must be before end time.   
Assessment Date must be after Course Section Start Date.   
Course Assessment Type must be active.   
Location must be active.   
top
 

Course_Section_DefinitionObject

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

Course_Assessment_TypeObject

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

Course_Assessment_TypeObjectID

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

Delivery_ModeObject

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

Delivery_ModeObjectID

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

LocationObject

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

LocationObjectID

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

Scheduled_AssessmentReferenceEnumeration

part of: Scheduled_AssessmentObjectID
Base Type
string
top
 

Course_Section_DefinitionReferenceEnumeration

part of: Course_Section_DefinitionObjectID
Base Type
string
top
 

Course_Assessment_TypeReferenceEnumeration

part of: Course_Assessment_TypeObjectID
Base Type
string
top
 

Delivery_ModeReferenceEnumeration

part of: Delivery_ModeObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top