Service Directory > v32.1 > Talent > Get_Schools
 

Operation: Get_Schools

This operation allows retrieval of school information.


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

Top-level element for this operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   School_Request_References  [0..1]  Wrapper element for zero or more references.   
Request_Criteria [Choice]   School_Request_Criteria  [0..1]  Currently not in use. May be omitted.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  School_Response_Group  [0..1]  Wrapper element for items that specify response characteristics.   
top
 

Response Element: Get_Schools_Response

Top-level element for this operation's response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  School_Request_References  [0..1]  Wrapper element for Reference IDs that indicate specific Schools.   
Request_Criteria  School_Request_Criteria  [0..1]  Currently not in use. May be omitted.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  School_Response_Group  [0..1]  Wrapper element for items that specify response characteristics.   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  School_Response_Data  [0..1]  Wrapper element for School data.   
top
 

School_Request_References

part of: Get_Schools_Request, Get_Schools_Response
Wrapper element for zero or more references.
 
Parameter name Type/Value Cardinality Description Validations
School_Reference  SchoolObject  [1..*]  Reference ID to indicate a specific School.   
top
 

SchoolObject

part of: School_Request_References, School, 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  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_Request_Criteria

part of: Get_Schools_Request, Get_Schools_Response
Currently not in use. May be omitted.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Schools_Request, Get_Schools_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

School_Response_Group

part of: Get_Schools_Request, Get_Schools_Response
Wrapper element for items that specify response characteristics.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Set this to 1 in order to include Reference ID elements in the response.   
top
 

Response_Results

part of: Get_Schools_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

School_Response_Data

part of: Get_Schools_Response
Wrapper for School element
 
Parameter name Type/Value Cardinality Description Validations
School  School  [0..*]  Wrapper for School Reference and Data elements.   
top
 

School

part of: School_Response_Data
Wrapper element for School Reference and Data elements
 
Parameter name Type/Value Cardinality Description Validations
School_Reference  SchoolObject  [0..1]  Wrapper for Reference ID, which indicates a specific School.   
School_Data  School_Data  [0..1]  Encapsulating element containing all School data. 
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_Data

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