Service Directory > v31.2 > Human_Resources > Get_Academic_Units
 

Operation: Get_Academic_Units

Returns detailed information for Academic Units.


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

A container for a request for one or more Academic Units
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Academic_Unit_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Academic_Unit_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Academic_Unit_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Academic_Units_Response

A container for Academic Unit response data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Academic_Unit_Request_References  [0..1]  A container for Academic Unit request references   
Request_Criteria  Academic_Unit_Request_Criteria  [0..1]  A container for Academic Unit request criteria   
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  Academic_Unit_Response_Group  [0..1]  Response Group   
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  Academic_Unit_Response_Data  [0..1]  A container for Academic Unit responses   
top
 

Academic_Unit_Request_References

part of: Get_Academic_Units_Request, Get_Academic_Units_Response
A collection of references to one or more Academic Units
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_UnitObject  [1..*]  A collection of references to one or more Academic Units   
top
 

Academic_UnitObject

part of: Academic_Unit_Request_References, Academic_Unit, Academic_Unit_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  Academic_UnitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_UnitObjectID

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

Academic_Unit_Request_Criteria

part of: Get_Academic_Units_Request, Get_Academic_Units_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Name  string  [1..1]  The Name of the Academic Unit   
Effective_As_Of_Date  date  [0..1]  Effective As of Date   
top
 

Response_Filter

part of: Get_Academic_Units_Request, Get_Academic_Units_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
 

Academic_Unit_Response_Group

part of: Get_Academic_Units_Request, Get_Academic_Units_Response
Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Academic_Unit_Response_Data

part of: Get_Academic_Units_Response
A container for Academic Unit responses
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit  Academic_Unit  [0..*]  A container for Academic Unit Data   
top
 

Academic_Unit

part of: Academic_Unit_Response_Data
A container for Academic Unit Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_UnitObject  [0..1]  A reference to the Academic Unit   
Academic_Unit_Data  Academic_Unit_Data  [0..1]  A container for detailed information about the Academic Unit 
Validation Description
You cannot inactivate an Institutional academic unit.   
You can only specify the Acceptable External Institution Grading Scheme Point Value for Institutional academic units.   
Company currency does not match the default currency for the tenant: [currency].   
 
top
 

Academic_Unit_Data

part of: Academic_Unit
A container for all the detail information about the Academic Unit
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A Reference ID for the Academic Unit generated by Workday and used for internal purposes only   
Effective_Date  date  [0..1]  Effective as of Date   
Name  string  [0..1]  The Name of the Academic Unit 
Validation Description
Academic Unit Name is required on add.   
 
Code  string  [0..1]  A functional ID for the Academic Unit available to system users and in the display ID, if desired   
Is_Institution  boolean  [0..1]  Indicates whether the Academic Unit is designated as an institution. 
Validation Description
This Academic Unit cannot be designated as an institution because [Institution AU] is already designated as an institution in the structure.   
 
Include_Code_in_Name  boolean  [0..1]  Indicates whether the functional ID should be included as part of the display ID (Name). If this value is set, the Code field is pre-pended to the Name with a hyphen separator   
Include_Incumbent_Leader_in_Name  boolean  [0..1]  Indicates whether or not the person holding the leadership role for the Academic Unit's name will be included as part of the display ID (Name). If set, this value will cause the leader's name to be appended in parentheses to the Academic Unit's name.   
Academic_Organization_Subtype_Reference  Academic_Unit_SubtypeObject  [0..1]  A reference to the Academic Unit Subtype for this Academic Unit (required) 
Validation Description
Academic Unit Subtype is required on add.   
 
Include_Subtype_in_Name  boolean  [0..1]  Indicates whether or not the Academic Unit Subtype should be part of the Academic Unit's display ID (Name). If set, this value will cause the Subtype Name to be appended to the Academic Unit's Name. The default for this value is false.   
Inactive  boolean  [0..1]  Indicates whether or not the Academic Unit is considered Inactive. If set, the static text (Inactive) will be appended to the Academic Unit's default display ID (Name). Inactive Academic Units are not available for selection when adding or updating Appointments. Inactive Academic Units, however, can continue to contain historical Appointments and can be viewed and reported on. Prompts will include the Inactive Academic Units in a separate folder.   
Company_Reference  CompanyObject  [0..1]  Provides a reference to the Company associated with the Academic Unit.   
CIP_Code_Reference  CIP_Code__Workday_Owned_Object  [0..1]  Provides a reference to a CIP code for this Academic Unit.   
External_URL_Reference  External_URLObject  [0..1]  One or more references to an external URL (e.g. home page for the department or school)   
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [0..*]  Provides a reference to a Supervisory Organization associated with the Academic Unit.   
Track_Type_Reference  Academic_Track_TypeObject  [0..*]  A list of references to Academic Track Types allowable for this Academic Unit   
Superior_Academic_Unit_Reference  Academic_UnitObject  [0..1]  Field for providing a reference to the Superior Academic Unit of this Academic Unit. 
Validation Description
Assigning this superior academic unit would create a circular reference.   
 
Acceptable_External_Institution_Grading_Scheme_Point_Value_Reference  External_Institution_Grading_Scheme_Grade_Point_ValueObject  [0..1]  Reference to an External Institutional Grading Scheme Grade Point Value which determines if external course will receive transfer credit.   
Validation Description
You cannot inactivate an Institutional academic unit.   
You can only specify the Acceptable External Institution Grading Scheme Point Value for Institutional academic units.   
Company currency does not match the default currency for the tenant: [currency].   
top
 

Academic_Unit_SubtypeObject

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

Academic_Unit_SubtypeObjectID

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

CompanyObject

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

CompanyObjectID

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

CIP_Code__Workday_Owned_Object

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

CIP_Code__Workday_Owned_ObjectID

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

External_URLObject

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

External_URLObjectID

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

Supervisory_OrganizationObject

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

Supervisory_OrganizationObjectID

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

Academic_Track_TypeObject

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

Academic_Track_TypeObjectID

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

External_Institution_Grading_Scheme_Grade_Point_ValueObject

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

External_Institution_Grading_Scheme_Grade_Point_ValueObjectID

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

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_Unit_SubtypeReferenceEnumeration

part of: Academic_Unit_SubtypeObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CIP_Code__Workday_Owned_ReferenceEnumeration

part of: CIP_Code__Workday_Owned_ObjectID
Base Type
string
top
 

External_URLReferenceEnumeration

part of: External_URLObjectID
Base Type
string
top
 

Supervisory_OrganizationReferenceEnumeration

part of: Supervisory_OrganizationObjectID
Base Type
string
top
 

Academic_Track_TypeReferenceEnumeration

part of: Academic_Track_TypeObjectID
Base Type
string
top
 

External_Institution_Grading_Scheme_Grade_Point_ValueReferenceEnumeration

part of: External_Institution_Grading_Scheme_Grade_Point_ValueObjectID
Base Type
string
top