Service Directory > v31.2 > Academic_Foundation > Put_Educational_Taxonomy_Scheme
 

Operation: Put_Educational_Taxonomy_Scheme

Creates a new Educational Taxonomy Scheme (or updates an existing Educational Taxonomy Scheme) with the information supplied in the request.


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

Wrapper element for Put Educational Taxonomy Scheme Request
 
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_Taxonomy_Scheme_Reference  Educational_Taxonomy_SchemeObject  [0..1]  Reference ID for Educational Taxonomy Scheme   
Educational_Taxonomy_Scheme_Data  Educational_Taxonomy_Scheme_Data  [0..1]  Wrapper element for the Educational Taxonomy Scheme data   
Validation Description
The web service is set to Add Only but the Educational Taxonomy Scheme already exists.   
top
 

Response Element: Put_Educational_Taxonomy_Scheme_Response

Response data for Put Educational Taxonomy Scheme
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Educational_Taxonomy_Scheme_Reference  Educational_Taxonomy_SchemeObject  [0..1]  Reference ID for Educational Taxonomy Scheme   
Educational_Taxonomy_Scheme_Data  Educational_Taxonomy_Scheme_Data  [0..1]  Wrapper element for the Educational Taxonomy Scheme data   
top
 

Educational_Taxonomy_SchemeObject

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

Educational_Taxonomy_SchemeObjectID

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

Educational_Taxonomy_Scheme_Data

part of: Put_Educational_Taxonomy_Scheme_Request, Put_Educational_Taxonomy_Scheme_Response
Wrapper element for the Educational Taxonomy Scheme data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Educational Taxonomy Scheme   
Country___Country_Region_Reference  Location_ContextObject  [1..1]  Educational Taxonomy Scheme Location Context (Country) 
Validation Description
Scheme location may not be changed after creation.   
 
Name  string  [1..1]  Educational Taxonomy Scheme Name 
Validation Description
Enter a Name that isn't already in use in this Country or select a different Country.   
 
Description  string  [1..1]  Educational Taxonomy Scheme Description   
Inactive  boolean  [0..1]  Educational Taxonomy Scheme Inactive   
Educational_Taxonomy_Code_Format_Reference  Educational_Taxonomy_Code_FormatObject  [0..1]  The Reference ID of the Code Format used by this Educational Taxonomy Scheme   
Educational_Taxonomy_Code_Data  Educational_Taxonomy_Code_Data  [1..*]  Wrapper element for Educational Taxonomy Code data   
top
 

Location_ContextObject

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

Location_ContextObjectID

part of: Location_ContextObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Region_ID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_ID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-2_Code  [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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [1..1]  The unique identifier type of a parent object   
top
 

Educational_Taxonomy_Code_FormatObject

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

Educational_Taxonomy_Code_FormatObjectID

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

Educational_Taxonomy_Code_Data

part of: Educational_Taxonomy_Scheme_Data
Wrapper element for Educational Taxonomy Code data.
 
Parameter name Type/Value Cardinality Description Validations
Educational_Taxonomy_Code_Reference  Educational_Taxonomy_CodeObject  [0..1]  Reference ID for Educational Taxonomy Code   
Code  string  [1..1]  Educational Taxonomy Code 
Validation Description
Enter a Code that isn't already in use by this scheme.   
Enter a Code that matches the scheme's Code Format.   
 
Description  string  [0..1]  Educational Taxonomy Code Description (Optional)   
ID  string  [0..1]  ID for Educational Taxonomy Code   
top
 

Educational_Taxonomy_CodeObject

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

Educational_Taxonomy_CodeObjectID

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

Educational_Taxonomy_SchemeReferenceEnumeration

part of: Educational_Taxonomy_SchemeObjectID
Base Type
string
top
 

Location_ContextReferenceEnumeration

part of: Location_ContextObjectID
Base Type
string
top
 

Base Type
string

top
 

Educational_Taxonomy_Code_FormatReferenceEnumeration

part of: Educational_Taxonomy_Code_FormatObjectID
Base Type
string
top
 

Educational_Taxonomy_CodeReferenceEnumeration

part of: Educational_Taxonomy_CodeObjectID
Base Type
string
top