Service Directory > v31.2 > Talent > Put_School
 

Operation: Put_School

This operation adds or updates a School.


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

Contains the response elements for the Get Schhols and Put School service requests.
 
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. If set true, then attempting to submit a duplicate will result in an error.   
@Delete  boolean  [1..1]  When true, will delete the existing School.   
School_Reference  SchoolObject  [0..1]  Containing element for ID element that identifies specific schools.   
School_Data  School_Data  [0..1]  Containing element for School Reference. 
Validation Description
A School can only be marked as a duplicate of another active School.   
Enter a valid school reference ID to mark a Duplicate School.   
The field Country is required and must have a value.   
 
Validation Description
School "[school]" already exists.   
You can't delete and edit a school at the same time.  You can't delete and edit a school at the same time. 
You can't delete this school because it is in use as a professional affiliation.   
School "[school]" already exists.   
top
 

Response Element: Put_School_Response

Top-level element for this response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
School_Reference  SchoolObject  [0..1]  Reference ID for the School.   
top
 

SchoolObject

part of: School_Data, Put_School_Request, Put_School_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  SchoolObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

SchoolObjectID

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

School_Data

part of: Put_School_Request
Encapsulating element containing all School data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the school.   
School_Name  string  [1..1]  The name of the school.   
School_Type_Reference  School_TypeObject  [0..1]  The type of school.   
Country_Region_Reference  Country_RegionObject  [0..1]  The state or province in which the school is located.   
Country_Reference  CountryObject  [0..1]  The country in which the school is located.   
Inactive  boolean  [0..1]  Indicates whether or not the school is active in the system, which allows users to select the school from prompts.   
Duplicate_School_Reference  SchoolObject  [0..1]  The Reference ID of the school that this school is a duplicate of.   
Validation Description
A School can only be marked as a duplicate of another active School.   
Enter a valid school reference ID to mark a Duplicate School.   
The field Country is required and must have a value.   
top
 

School_TypeObject

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

School_TypeObjectID

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

Country_RegionObject

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

Country_RegionObjectID

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

CountryObject

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

CountryObjectID

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

SchoolReferenceEnumeration

part of: SchoolObjectID
Base Type
string
top
 

School_TypeReferenceEnumeration

part of: School_TypeObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top