Service Directory > v31.2 > Academic_Foundation > Put_Student_Educational_Institution_District
 

Operation: Put_Student_Educational_Institution_District

Adds a new Educational Institution District (or updates an existing Educational Institution District) with the information supplied in the request. Valid for >=w25


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

Wrapper element for the Put Educational Institution District Request Information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Educational_Institution_District_Reference  Educational_Institution_DistrictObject  [0..1]  The reference to the Educational Institution District being updated. For new Educational Institution Districts, this element will not exist.   
Student_Educational_Institution_District_Data  Student_Educational_Institution_District_Data  [1..1]  Student Educational Institution District Data   
Validation Description
The Web Service is set to Add Only, but the Educational Institution District already exists.   
top
 

Response Element: Put_Student_Educational_Institution_District_Response

Wrapper element for the Put Educational Institution District Returned data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Educational_Institution_District_Reference  Educational_Institution_DistrictObject  [0..1]  The reference to the Educational Institution District which was added or updated.   
top
 

Educational_Institution_DistrictObject

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

Educational_Institution_DistrictObjectID

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

part of: Put_Student_Educational_Institution_District_Request
Student Educational Institution District Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Educational Institution District Reference ID   
Educational_Institution_District_Name  string  [1..1]  Educational Institution District Name   
Educational_Institution_District_NCES_ID  string  [0..1]  Educational Institution District NCES ID   
Educational_Institution_District_State_ID  string  [0..1]  Educational Institution District State ID   
top
 

Educational_Institution_DistrictReferenceEnumeration

part of: Educational_Institution_DistrictObjectID
Base Type
string
top