Service Directory > v31.2 > Student_Records > Import_Student_Matriculations
 

Operation: Import_Student_Matriculations

This implementation web service is the only way to Matriculate a Student (enroll a Student: create a Student Record, create a Student ID, etc.) via web service. Prior to using this web service, the Student Applications must be created via the Import Student Application web service. If there is absolutely no way to obtain the application information, then the Import Student Personal Information may be used as an alternative.


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

Web Service element for the Import Student Matriculations Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  ID for the Student Matriculation Data Load   
Student_Matriculation_Data  Student_Matriculation_Data  [0..*]  Web Service element for Student Matriculation Data 
Validation Description
The Student Application has already been Matriculated.   
Provide either a Student Application or Pre-Matriculation Data.   
Academic Records must be for the same Student.   
Academic Records must have matching Unit Types.   
An existing academic record cannot be updated.   
The selected Student is a duplicate of an existing student.   
 
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
 

Student_Matriculation_Data

part of: Import_Student_Matriculations_Request
Web Service element for Student Matriculation Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Record_ID  string  [0..1]  The ID of the Academic Record that is created. Must be unique, will be automatically assigned if not provided.   
Student_Application_Reference  Student_ApplicationObject  [0..1]  The reference Student Application   
Pre-Matriculation_Data  Pre-Matriculation_Data  [0..1]  Contains data required for matriculating a Student. 
Validation Description
All Programs of Study must be offered by the same academic unit and level for the selected Anticipated Start date.   
The selected Primary Program of Study must be standalone   
The selected Student cannot be a duplicate   
The Student already has an Academic Record with a Primary Program of Study with this Start Date.   
 
Academic_Records_Reference  Academic_RecordObject  [0..*]  Academic Records to copy registrations from.   
Validation Description
The Student Application has already been Matriculated.   
Provide either a Student Application or Pre-Matriculation Data.   
Academic Records must be for the same Student.   
Academic Records must have matching Unit Types.   
An existing academic record cannot be updated.   
The selected Student is a duplicate of an existing student.   
top
 

Student_ApplicationObject

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

Student_ApplicationObjectID

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

Pre-Matriculation_Data

part of: Student_Matriculation_Data
Contains data required for matriculating a Student.
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  Student Reference   
Academic_Period_Data  Academic_Period_Subedit_Data  [1..1]  Contains Academic Period information for a Student Prospect 
Validation Description
Academic Period End/Start Date cannot be used in conjunction with Academic Period and vice versa.   
 
Primary_Program_of_Study_Reference  Program_of_StudyObject  [1..1]  Primary Program of Study Reference   
Additional_Programs_of_Study_Reference  Program_of_StudyObject  [0..*]  Additional Program of Study Reference   
Location_Reference  LocationObject  [0..1]  Location Reference   
Validation Description
All Programs of Study must be offered by the same academic unit and level for the selected Anticipated Start date.   
The selected Primary Program of Study must be standalone   
The selected Student cannot be a duplicate   
The Student already has an Academic Record with a Primary Program of Study with this Start Date.   
top
 

StudentObject

part of: Pre-Matriculation_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_Period_Subedit_Data

part of: Pre-Matriculation_Data
Contains Academic Period information for a Student Prospect
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Reference  Academic_PeriodObject  [0..1]  References an Academic Period for a Student Prospect   
Academic_Period_Start_Date  date  [0..1]  References an Academic Period Start Date for a Student Prospect 
Validation Description
You must enter an Academic Period Start Date if the Academic Period End Date is in use.   
Enter an Academic End Date that is after the Academic Start Date.   
 
Academic_Period_End_Date  date  [0..1]  References an Academic Period End Date for a Student Prospect   
Validation Description
Academic Period End/Start Date cannot be used in conjunction with Academic Period and vice versa.   
top
 

Academic_PeriodObject

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

Program_of_StudyObject

part of: Pre-Matriculation_Data, Pre-Matriculation_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
 

LocationObject

part of: Pre-Matriculation_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
 

Academic_RecordObject

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

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
 

Student_ApplicationReferenceEnumeration

part of: Student_ApplicationObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top