Service Directory > v31.2 > Student_Records > Import_Program_of_Study_Assignment_Snapshot
 

Operation: Import_Program_of_Study_Assignment_Snapshot

This processes uses Put-type web service operation to load the Program of Study Assignment Snapshots for a Student's Academic Record. This will replace all of the existing Student's Academic Record's transactional history with the newly specified Programs of Study, Statuses, and Effective Dates.


@ - 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: Import_Program_of_Study_Assignment_Snapshot_Request

Import Program of Study Assignment Snapshot Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  ID   
Import_Student_Program_of_Study_Assignment_Snapshot_Data  Import_Student_Program_of_Study_Assignment_Snapshot_Data  [0..*]  Import Student Program of Study Assignment Snapshot Data 
Validation Description
Academic Record Reference must be for the Student Reference.   
Student has more than one Academic Record. Please submit Academic Record Reference.   
Submit either Student Reference or Academic Record Reference.   
There is an In Progress or Revised Edit Program of Study for Student Event for this Academic Record.   
An Academic Record may only have 1 future effective-dated snapshot.   
 
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Import_Student_Program_of_Study_Assignment_Snapshot_Data

part of: Import_Program_of_Study_Assignment_Snapshot_Request
Import Program of Study Assignment Snapshot Request
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Academic Record   
Program_of_Study_Assignment_Snapshot_Data  Program_of_Study_Assignment_Snapshot_Data  [1..*]  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.   
Complete Status can only be set on the last row.   
Only the first Effective Dated row may contain Matriculated Statuses.   
The only different Status that can appear in a row is Discontinued.   
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.   
 
Validation Description
Academic Record Reference must be for the Student Reference.   
Student has more than one Academic Record. Please submit Academic Record Reference.   
Submit either Student Reference or Academic Record Reference.   
There is an In Progress or Revised Edit Program of Study for Student Event for this Academic Record.   
An Academic Record may only have 1 future effective-dated snapshot.   
top
 

StudentObject

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

Program_of_Study_Assignment_Snapshot_Data

part of: Import_Student_Program_of_Study_Assignment_Snapshot_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.   
 
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.   
Complete Status can only be set on the last row.   
Only the first Effective Dated row may contain Matriculated Statuses.   
The only different Status that can appear in a row is Discontinued.   
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.   
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   
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.   
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
 

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
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
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top