Service Directory > v32.1 > Revenue_Management > Get_Facilities_and_Administration_Rate_Agreements
 

Operation: Get_Facilities_and_Administration_Rate_Agreements

Web Service in retrieving Facilities and Administration Rate Agreements


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

Facilities and Administration Rate Agreements Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Facilities_and_Administration_Rate_Agreement_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Facilities_and_Administration_Rate_Agreement_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  Facilities_and_Administration_Rate_Agreement_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Facilities_and_Administration_Rate_Agreements_Response

Get Facilities and Administration Rate Agreements Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Facilities_and_Administration_Rate_Agreement_Request_References  [0..1]  Facilities and Administration Rate Agreement Reference   
Request_Criteria  Facilities_and_Administration_Rate_Agreement_Request_Criteria  [0..1]  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  Facilities_and_Administration_Rate_Agreement_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  Facilities_and_Administration_Rate_Agreement_Response_Data  [0..1]  Facilities and Administration Rate Agreement Response Data   
top
 

Facilities_and_Administration_Rate_Agreement_Request_References

part of: Get_Facilities_and_Administration_Rate_Agreements_Request, Get_Facilities_and_Administration_Rate_Agreements_Response
Facilities and Administration Rate Agreement Reference
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Rate_Agreement_Reference  Facilities_and_Admin_Rate_AgreementObject  [1..*]  Facilities and Administration Rate Agreement Reference   
top
 

Facilities_and_Admin_Rate_AgreementObject

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

Facilities_and_Admin_Rate_AgreementObjectID

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

part of: Get_Facilities_and_Administration_Rate_Agreements_Request, Get_Facilities_and_Administration_Rate_Agreements_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Rate_Agreement_Name  string  [0..1]  Find Rate Agreement via its Name.   
Rate_Agreement_Basis_Type_Reference  Facilities_and_Admin_Basis_TypeObject  [0..1]  Find Rate Agreement(s) via their Facilities and Admin Basis Type.   
Rate_Agreement_Date  date  [0..1]  Find Rate Agreement(s) via Rate Agreement Date.   
top
 

Facilities_and_Admin_Basis_TypeObject

part of: Facilities_and_Administration_Rate_Agreement_Request_Criteria, Facilities_and_Administration_Rate_Agreement_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
 

Response_Filter

part of: Get_Facilities_and_Administration_Rate_Agreements_Request, Get_Facilities_and_Administration_Rate_Agreements_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_Administration_Rate_Agreement_Response_Group

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

Response_Results

part of: Get_Facilities_and_Administration_Rate_Agreements_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_Administration_Rate_Agreement_Response_Data

part of: Get_Facilities_and_Administration_Rate_Agreements_Response
Facilities and Administration Rate Agreement Response Data
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Rate_Agreement  Facilities_and_Administration_Rate_Agreement  [0..*]  Facilities and Administration Rate Agreement Response.   
top
 

Facilities_and_Administration_Rate_Agreement

part of: Facilities_and_Administration_Rate_Agreement_Response_Data
Facilities and Administration Rate Agreement Response Data
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Rate_Agreement_Reference  Facilities_and_Admin_Rate_AgreementObject  [0..1]  Facilities and Administration Rate Agreement Reference   
Facilities_and_Administration_Rate_Agreement_Data  Facilities_and_Administration_Rate_Agreement_Data  [0..*]  The Request for creating a new Rate Agreement. 
Validation Description
The Rate Agreement Name & Date combination already exists.   
Can't delete Cost Rate Types that are tied to Award Lines.   
 
top
 

Facilities_and_Administration_Rate_Agreement_Data

part of: Facilities_and_Administration_Rate_Agreement
The Request for creating a new Rate Agreement.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Rate_Agreement_ID  string  [0..1]  The Rate Agreement ID.   
Name  string  [1..1]  The Cost Rate Agreement Name.   
Date  date  [1..1]  The Cost Rate Agreement Date.   
Rate_Agreement_Basis_Type_Reference  Facilities_and_Admin_Basis_TypeObject  [1..1]  The Cost Rate Agreement's Basis Type.   
Description  RichText  [0..1]  The Cost Rate Agreement's Description.   
Rate_Agreement_Cost_Rate_Data  Rate_Agreement_Cost_Rate_Data  [0..*]  The Cost Rate Agreement's Rate Types. 
Validation Description
A Rate Agreement can't have multiple Rate Types with the same name.   
Cost Rate Types can't belong to two different Rate Agreements.   
 
Validation Description
The Rate Agreement Name & Date combination already exists.   
Can't delete Cost Rate Types that are tied to Award Lines.   
top
 

Rate_Agreement_Cost_Rate_Data

part of: Facilities_and_Administration_Rate_Agreement_Data
Contains the Cost Rate Type for the particular Rate Agreement.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Admin_Cost_Rate_Type_Reference  Facilities_and_Admin_Cost_Rate_TypeObject  [0..1]  The Cost Rate Type for the related Rate Agreement.   
Facilities_and_Admin_Cost_Rate_Type_ID  string  [0..1]  The unique identifier for the facilities and administration cost rate type.   
Facilities_and_Admin_Cost_Rate_Definition_Name_Reference  Facilities_and_Admin_Cost_Rate_Definition_NameObject  [1..1]  The Cost Rate Defintion Name which includes the Name and Location for the related Cost Rate Type.   
Facilities_and_Admin_Cost_Rate_Type_Snapshot_Data  Facilities_and_Admin_Cost_Rate_Type_Snapshot_Data  [0..*]  Contains the different percentages and their effective dates known as Snapshots for the related Cost Rate Type. 
Validation Description
Rate Types can't have two of the same effective dates.   
 
Validation Description
A Rate Agreement can't have multiple Rate Types with the same name.   
Cost Rate Types can't belong to two different Rate Agreements.   
top
 

Facilities_and_Admin_Cost_Rate_TypeObject

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

Facilities_and_Admin_Cost_Rate_TypeObjectID

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

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

Facilities_and_Admin_Cost_Rate_Definition_NameObjectID

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

part of: Rate_Agreement_Cost_Rate_Data
The Cost Rate Type Snapshot for the related Cost Rate Type.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Admin_Cost_Rate_Type_Snapshot_Reference  Unique_IdentifierObject  [0..1]  Facilities and Admin Cost Rate Type Snapshot for related Cost Rate Type.   
Facilities_and_Admin_Cost_Rate_Type_Type_Reference  Facilities_and_Admin_Cost_Rate_Type_TypeObject  [0..1]  The Cost Rate Type type for the related Cost Rate Type.   
Snapshot_Effective_Date  date  [1..1]  The Start Effective Date of the this Snapshot of the Cost Rate Type.   
Percent  decimal (7, 4) >0   [0..1]  The Percentage applicable for the particular Cost Rate Type.   
Validation Description
Rate Types can't have two of the same effective dates.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

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

Facilities_and_Admin_Cost_Rate_Type_TypeObjectID

part of: Facilities_and_Admin_Cost_Rate_Type_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_Cost_Rate_Type_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_Rate_AgreementReferenceEnumeration

part of: Facilities_and_Admin_Rate_AgreementObjectID
Base Type
string
top
 

Facilities_and_Admin_Basis_TypeReferenceEnumeration

part of: Facilities_and_Admin_Basis_TypeObjectID
Base Type
string
top
 

RichText

part of: Facilities_and_Administration_Rate_Agreement_Data
Base Type
string
top
 

Facilities_and_Admin_Cost_Rate_TypeReferenceEnumeration

part of: Facilities_and_Admin_Cost_Rate_TypeObjectID
Base Type
string
top
 

Facilities_and_Admin_Cost_Rate_Definition_NameReferenceEnumeration

part of: Facilities_and_Admin_Cost_Rate_Definition_NameObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Facilities_and_Admin_Cost_Rate_Type_TypeReferenceEnumeration

part of: Facilities_and_Admin_Cost_Rate_Type_TypeObjectID
Base Type
string
top