Service Directory > v32.1 > Student_Records > Get_Program_of_Study_Assignment_Snapshots
 

Operation: Get_Program_of_Study_Assignment_Snapshots

Returns the programs of study history with statuses and effective dates for the students and academic records specified. If the student is referenced, the program of study history for all their academic records will be returned. If only the academic record is referenced, the program of study history for that particular record will be returned.


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

Get Program of Study Assignment Snapshot Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Program_of_Study_Assignment_Snapshot_Request_References  [0..1]  Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Program_of_Study_Assignment_Snapshots_Response

Get Program of Study Assignment Snapshot Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Program_of_Study_Assignment_Snapshot_Request_References  [0..1]  Request References   
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  Program_of_Study_Assignment_Snapshot_Response_Data  [0..1]  Response Data Element for Web Service   
top
 

Program_of_Study_Assignment_Snapshot_Request_References

part of: Get_Program_of_Study_Assignment_Snapshots_Request, Get_Program_of_Study_Assignment_Snapshots_Response
Request References
 
Parameter name Type/Value Cardinality Description Validations
Students_Reference  StudentObject  [0..*]  Student Reference   
Academic_Records_Reference  Academic_RecordObject  [0..*]  Academic Record Reference   
top
 

StudentObject

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

StudentObjectID

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

part of: Program_of_Study_Assignment_Snapshot_Request_References, Program_of_Study_Assignment_Snapshot_for_Academic_Record_Response_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_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
 

Response_Filter

part of: Get_Program_of_Study_Assignment_Snapshots_Request, Get_Program_of_Study_Assignment_Snapshots_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_Program_of_Study_Assignment_Snapshots_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
 

Program_of_Study_Assignment_Snapshot_Response_Data

part of: Get_Program_of_Study_Assignment_Snapshots_Response
Get Program of Study Assignment Snapshots Response Data
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Assignment_Snapshot_for_Academic_Record_Data  Program_of_Study_Assignment_Snapshot_for_Academic_Record_Response_Data  [0..*]  Program of Study Assignment Snapshot for Academic Record Response Data   
top
 

Program_of_Study_Assignment_Snapshot_for_Academic_Record_Response_Data

part of: Program_of_Study_Assignment_Snapshot_Response_Data
Program of Study Assignment Snapshot for Academic Record Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Secured   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Academic Records Secured   
Program_of_Study_Assignment_Snapshot_Data  Program_of_Study_Assignment_Snapshot_Data  [0..*]  Program of Study Assignment Snapshot Data 
Validation Description
This row must contain all of the Programs of Study from all of the previous rows.   
Cannot have duplicate Programs of Study in a row.   
One Primary Program of Study must be selected for the Effective Dated row.   
Must have unique Order for each Effective Dated row.   
Only the first Effective Dated row may contain Matriculated Statuses.   
The first Effective Dated row must contain only Matriculated Statuses.   
Effective Dated rows must be ordered by Effective Date.   
Enter an Effective Date of [start date of current period] or [start date of next period].   
You must pick an effective date that is after current or future Academic Periods with registrations to change to a primary Program of Study on a different Academic Calendar.   
Statuses must be the same unless they are discontinued or complete.   
 
top
 

Program_of_Study_Assignment_Snapshot_Data

part of: Program_of_Study_Assignment_Snapshot_for_Academic_Record_Response_Data
Import Student Program of Study Assignment Snapshot Data
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [1..1]  Order   
Effective_Date  date  [1..1]  Snapshot Effective Date   
Program_of_Study_Assignment_Snapshot_Subedit_Data  Program_of_Study_Assignment_Snapshot_Subedit_Data  [1..*]  Program of Study Assignment Snapshot Subedit Data 
Validation Description
Program of Study must have an Effective Dated row with a prior In Progress Status.   
Program of Study must be Standalone in order to be Primary.   
Only Programs that have been previously Completed can have a Status of Complete.   
Effective Dated row after Program of Study with Leave of Absence Status must have an In Progress Status for the Program of Study.   
Expected Completion Date for the same Program of Study must be the same.   
Must enter a valid Student Program of Study Record Status.   
Expected Completion Date cannot be edited for existing Program of Study Record.   
Expected Completion Date must be entered for the new Program of Study.   
The Program of Study status reason is not eligible for the selected criteria   
Leave of Absence Event must have a Return date that is after the Start Date   
 
Validation Description
This row must contain all of the Programs of Study from all of the previous rows.   
Cannot have duplicate Programs of Study in a row.   
One Primary Program of Study must be selected for the Effective Dated row.   
Must have unique Order for each Effective Dated row.   
Only the first Effective Dated row may contain Matriculated Statuses.   
The first Effective Dated row must contain only Matriculated Statuses.   
Effective Dated rows must be ordered by Effective Date.   
Enter an Effective Date of [start date of current period] or [start date of next period].   
You must pick an effective date that is after current or future Academic Periods with registrations to change to a primary Program of Study on a different Academic Calendar.   
Statuses must be the same unless they are discontinued or complete.   
top
 

Program_of_Study_Assignment_Snapshot_Subedit_Data

part of: Program_of_Study_Assignment_Snapshot_Data
Program of Study Assignment Snapshot Subedit Data
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference  Program_of_StudyObject  [1..1]  Program of Study   
Is_Primary  boolean  [0..1]  Indicates if the Program of Study Is Primary   
Program_of_Study_Record_Status_Reference  Student_Program_of_Study_Record_StatusObject  [1..1]  The Program of Study Record Status for the Program of Study Record   
Program_of_Study_Record_Status_Reason_Reference  Student_Program_of_Study_Record_Status_Reason__All_Object  [0..1]  The Program of Study Record Status Reason for the Program of Study Record   
Expected_Completion_Date  date  [0..1]  Student Program of Study Record Expected Completion Date   
Validation Description
Program of Study must have an Effective Dated row with a prior In Progress Status.   
Program of Study must be Standalone in order to be Primary.   
Only Programs that have been previously Completed can have a Status of Complete.   
Effective Dated row after Program of Study with Leave of Absence Status must have an In Progress Status for the Program of Study.   
Expected Completion Date for the same Program of Study must be the same.   
Must enter a valid Student Program of Study Record Status.   
Expected Completion Date cannot be edited for existing Program of Study Record.   
Expected Completion Date must be entered for the new Program of Study.   
The Program of Study status reason is not eligible for the selected criteria   
Leave of Absence Event must have a Return date that is after the Start Date   
top
 

Program_of_StudyObject

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

Program_of_StudyObjectID

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

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

Student_Program_of_Study_Record_StatusObjectID

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

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

Student_Program_of_Study_Record_Status_Reason__All_ObjectID

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

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

Student_Program_of_Study_Record_StatusReferenceEnumeration

part of: Student_Program_of_Study_Record_StatusObjectID
Base Type
string
top
 

Student_Program_of_Study_Record_Status_Reason__All_ReferenceEnumeration

part of: Student_Program_of_Study_Record_Status_Reason__All_ObjectID
Base Type
string
top