Service Directory > v31.2 > Revenue_Management > Get_Facilities_and_Administration_Exceptions
 

Operation: Get_Facilities_and_Administration_Exceptions

This service operation retrieves Facilities and Administration Exceptions instances. The response includes the Facilities and Administration Exception, primary rate override, and override rates for the respective object class.


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

This element is the top-level request element for all "Get" Facilities and Administration Exceptions requests.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Facilities_and_Admin_Exception_Request_References  [0..1]  This element content contains the Facilities and Administration Exception reference element used to return the Facilities and Administration Exception by unique identifier   
Request_Criteria [Choice]   Facilities_and_Admin_Exception_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Facilities and Administration Exception specific criteria needed to search for instances.   
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  Facilities_and_Admin_Exception_Response_Group  [0..1]  Facilities and Administration Exception Response Group   
top
 

Response Element: Get_Facilities_and_Administration_Exceptions_Response

Element containing Facilities and Administration Exception response elements, including echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Facilities_and_Admin_Exception_Request_References  [0..1]  This element contains the specific instance set containing the requested Facilities and Administration Exception. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Facilities and Administration Exception.   
Request_Criteria  Facilities_and_Admin_Exception_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Facilities and Administration Exception specific criteria needed to search for instances. All of the elements are "AND" conditions.   
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  Facilities_and_Admin_Exception_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Facilities and Administration Exceptions response. If this element is not included then ALL of the Response Groups are included in the response.   
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  Facilities_and_Admin_Exception_Response_Data  [0..1]  Response Data   
top
 

Facilities_and_Admin_Exception_Request_References

part of: Get_Facilities_and_Administration_Exceptions_Request, Get_Facilities_and_Administration_Exceptions_Response
This element contains the specific instance set containing the requested Facilities and Administration Exception. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Facilities and Administration Exception.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Exception_Reference  Facilities_and_Admin_ExceptionObject  [1..*]  Facilities and Administration Exception requested for the Get operation   
top
 

Facilities_and_Admin_ExceptionObject

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

Facilities_and_Admin_ExceptionObjectID

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

Facilities_and_Admin_Exception_Request_Criteria

part of: Get_Facilities_and_Administration_Exceptions_Request, Get_Facilities_and_Administration_Exceptions_Response
This element is the wrapper around a list of elements representing the Facilities and Administration Exception specific criteria needed to search for instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Facilities_and_Administration_Exceptions_Request, Get_Facilities_and_Administration_Exceptions_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
 

Facilities_and_Admin_Exception_Response_Group

part of: Get_Facilities_and_Administration_Exceptions_Request, Get_Facilities_and_Administration_Exceptions_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Facilities and Administration Exceptions response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Facilities and Administration Exception Reference is to be included in the response   
top
 

Response_Results

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

Facilities_and_Admin_Exception_Response_Data

part of: Get_Facilities_and_Administration_Exceptions_Response
Wrapper element containing Facilities and Administration Exception Response Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Exception  Facilities_and_Admin_Exception  [0..*]  Facilities and Administration Exception element   
top
 

Facilities_and_Admin_Exception

part of: Facilities_and_Admin_Exception_Response_Data
Wrapper Element that includes all data for a single Facilities and Administration Exception.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Exception_Reference  Facilities_and_Admin_ExceptionObject  [0..1]  Reference to a single Facilities and Administration Exception for which data is being returned.   
Facilities_and_Administration_Exception_Data  Facilities_and_Admin_Exception_Data  [0..*]  This element contains all the data necessary to describe a Facilities and Administration Exception in Workday 
Validation Description
Facilities and Administration Exception data cannot be changed because it is referenced by an approved or amended Award. (Exception: [exception])   
Cannot delete the Facilities and Administration exception detail reference because the exception is referenced on an approved Award.   
The Facilities and Admin Exception Type entered must be valid for use on F&A Exceptions.   
If the Facilities and Administration Exception Type Entered does not indicate that the Facilities and Administration Exception should provide an Override F&A Rate, then the Override F&A Rate entered must be 0.   
If the Facilities and Administration Exception Type Entered does not indicate that the Facilities and Administration Exception should provide a Waive Rate, then the Waive Rate entered must be 0.   
If the Facilities and Administration Exception is configured to waive Facilities and Admin costs, it must have an associated Waived Expense Allocation Profile.   
 
top
 

Facilities_and_Admin_Exception_Data

part of: Facilities_and_Admin_Exception
Element containing Facilities and Administration Exception Data.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Exception_ID  string  [0..1]  This is the unique identifier for F&A Exception.   
Locked_in_Workday  boolean  [0..1]  Set to True to disable editing the F&A Exception inside the Workday application.   
Exception_Name  string  [1..1]  The name of the F&A Exception.   
Basis_Type_Reference  Facilities_and_Admin_Basis_TypeObject  [1..1]  Reference to an existing F&A Basis Type. Basis Type identifies the valid set of Object Classes to be used for this F&A Exception.   
Facilities_and_Admin_Exception_Type_Reference  Facilities_and_Admin_Exception_TypeObject  [1..1]  The primary type for the F&A Exception. If an exception type indicating an Facilities and Administration rate override is selected, every transaction against the award will use the primary rate on the exception for Facilities and Administration calculations, unless a Facilities and Administration Exception Detail for the Object Class for the Transaction specifies another rate to use. If an exception type indicating an Facilities and Administration waive rate is selected, every transaction against the award will use the primary waive rate on the exception for Facilities and Administration calculations, unless a Facilities and Administration Exception Detail for the Object Class for the Transaction specifies another waive rate to use.   
Primary_Rate_Override  decimal (7, 4) >0   [0..1]  Rate as percent entered in decimal format, ex: enter 1 for 100%, .5 for 50%, etc   
Primary_Waive_Rate  decimal (7, 4) >0   [0..1]  Rate as percent entered in decimal format, ex: enter 1 for 100%, .5 for 50%, etc   
Facilities_and_Administration_Waived_Expense_Allocation_Profile_Reference  Facilities_and_Admin_Waived_Expense_Allocation_ProfileObject  [0..1]  Reference to the Facilities and Administration Waived Expense Allocation Profile which allocates costs for Facilities and Administration Excptions that waive any portion Facilities and Administration costs.   
Exception_Detail_Data  Facilities_and_Admin_Exception_Detail_Data  [0..*]  Wrapper element containing exception rates by object class. 
Validation Description
Facilities and Administration Exception Detail Data cannot be changed because it is referenced by an approved or amended Award. (Exception: [exception]; Object Class: [object])   
The Object Class has already been specified for this exception. Object class must be unique per exception. (Object class: [object])   
Object Class specified is not valid for the Basis Type. Only object classes defined for the Basis Type are allowed. (Object Class: [object])   
The Facilities and Admin Exception Type entered must be valid for use on Facilities and Admin Exception Details.   
If the Facilities and Administration Exception Type Entered does not indicate that the Facilities and Administration Exception Detail should provide an Override Rate, then the Override Rate entered must be 0.   
If the Facilities and Administration Exception Type Entered does not indicate that the Facilities and Administration Exception Detail should provide a Waive Rate, then the Waive Rate entered must be 0.   
 
Validation Description
Facilities and Administration Exception data cannot be changed because it is referenced by an approved or amended Award. (Exception: [exception])   
Cannot delete the Facilities and Administration exception detail reference because the exception is referenced on an approved Award.   
The Facilities and Admin Exception Type entered must be valid for use on F&A Exceptions.   
If the Facilities and Administration Exception Type Entered does not indicate that the Facilities and Administration Exception should provide an Override F&A Rate, then the Override F&A Rate entered must be 0.   
If the Facilities and Administration Exception Type Entered does not indicate that the Facilities and Administration Exception should provide a Waive Rate, then the Waive Rate entered must be 0.   
If the Facilities and Administration Exception is configured to waive Facilities and Admin costs, it must have an associated Waived Expense Allocation Profile.   
top
 

Facilities_and_Admin_Basis_TypeObject

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

Facilities_and_Admin_Basis_TypeObjectID

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

Facilities_and_Admin_Exception_TypeObject

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

Facilities_and_Admin_Exception_TypeObjectID

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

Facilities_and_Admin_Waived_Expense_Allocation_ProfileObject

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

Facilities_and_Admin_Waived_Expense_Allocation_ProfileObjectID

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

Facilities_and_Admin_Exception_Detail_Data

part of: Facilities_and_Admin_Exception_Data
Wrapper element containing F&A Exception rates based on object class.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Exception_Detail_Reference  Facilities_and_Admin_Exception_DetailObject  [0..1]  This reference for the Facilities and Administration Exception Detail for update. If no reference specified, a new reference will be created.   
Object_Class_Reference  Object_ClassObject  [1..1]  Reference to an existing Object Class. Only Object Classes defined on the Basis Type referenced in the Facilities and Admin Exception Data are valid.   
Facilities_and_Admin_Exception_Type_Reference  Facilities_and_Admin_Exception_TypeObject  [1..1]  The Facilities and Administration Exception Type for the Exception Detail. The rate at which Facilities and Administration is calculated and/or waived can be overridden at the Object Class level. If an exception type that overrides the Facilities and Administration rate is chosen, transactions against and award line that have the object class for the Facilities and Administration Exception Detail will use the rate specified on the exception detail for Facilities and Administration calculations. If an exception type that waives Facilities and Administration is chosen, transactions against and award line that have the object class for the Facilities and Administration Exception Detail will use the rate specified on the exception detail calculating waived Facilities and Administration.   
Rate_Override  decimal (7, 4) >0   [0..1]  Rate for the Object Class reference as percent entered in decimal format, ex: enter 1 for 100%, .5 for 50%, etc.   
Waive_Rate  decimal (7, 4) >0   [0..1]  Rate for the Object Class reference as percent entered in decimal format, ex: enter 1 for 100%, .5 for 50%, etc.   
Validation Description
Facilities and Administration Exception Detail Data cannot be changed because it is referenced by an approved or amended Award. (Exception: [exception]; Object Class: [object])   
The Object Class has already been specified for this exception. Object class must be unique per exception. (Object class: [object])   
Object Class specified is not valid for the Basis Type. Only object classes defined for the Basis Type are allowed. (Object Class: [object])   
The Facilities and Admin Exception Type entered must be valid for use on Facilities and Admin Exception Details.   
If the Facilities and Administration Exception Type Entered does not indicate that the Facilities and Administration Exception Detail should provide an Override Rate, then the Override Rate entered must be 0.   
If the Facilities and Administration Exception Type Entered does not indicate that the Facilities and Administration Exception Detail should provide a Waive Rate, then the Waive Rate entered must be 0.   
top
 

Facilities_and_Admin_Exception_DetailObject

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

Facilities_and_Admin_Exception_DetailObjectID

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

Object_ClassObject

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

Object_ClassObjectID

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

Facilities_and_Admin_ExceptionReferenceEnumeration

part of: Facilities_and_Admin_ExceptionObjectID
Base Type
string
top
 

Facilities_and_Admin_Basis_TypeReferenceEnumeration

part of: Facilities_and_Admin_Basis_TypeObjectID
Base Type
string
top
 

Facilities_and_Admin_Exception_TypeReferenceEnumeration

part of: Facilities_and_Admin_Exception_TypeObjectID
Base Type
string
top
 

Facilities_and_Admin_Waived_Expense_Allocation_ProfileReferenceEnumeration

part of: Facilities_and_Admin_Waived_Expense_Allocation_ProfileObjectID
Base Type
string
top
 

Facilities_and_Admin_Exception_DetailReferenceEnumeration

part of: Facilities_and_Admin_Exception_DetailObjectID
Base Type
string
top
 

Object_ClassReferenceEnumeration

part of: Object_ClassObjectID
Base Type
string
top