Service Directory > v32.1 > Academic_Foundation > Import_Student_IDs
 

Operation: Import_Student_IDs

Import Student IDs is an edit-only, high-volume web service task that enables you to edit multiple Student IDs at once.


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

Import Student ID Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  The Reference ID of the Student ID Data Load header instance   
Student_ID_HV_Data  Student_ID_HV_Data  [0..*]  The high-volume data element for the Import Student IDs web service task 
Validation Description
The referenced Student does not have a Student ID. Please provide a reference to a Student with an existing Student ID.   
 
Validation Description
Please enter a Student ID Data Load ID that is not already in use.   
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_ID_HV_Data

part of: Import_Student_ID_Request
The high-volume data element for the Import Student IDs web service task
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  The reference to a Student.   
Student_ID_Data  Student_ID_Data  [1..*]  Contains the Student ID.   
Validation Description
The referenced Student does not have a Student ID. Please provide a reference to a Student with an existing Student ID.   
top
 

StudentObject

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

Student_ID_Data

part of: Student_ID_HV_Data
Contains the Student ID.
 
Parameter name Type/Value Cardinality Description Validations
Student_ID  string  [1..1]  The Student ID attribute.   
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
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top