Service Directory > v32.1 > Revenue_Management > Put_Facilities_and_Administration_Rate_Agreement
 

Operation: Put_Facilities_and_Administration_Rate_Agreement

Web service for adding Rate Agreements and its Cost Rate Types.


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

The Request for creating a new Rate Agreement.
 
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.   
Facilities_and_Administration_Rate_Agreement_Reference  Facilities_and_Admin_Rate_AgreementObject  [0..1]  The Cost Rate Agreement which we're referencing for updating.   
Facilities_and_Administration_Rate_Agreement_Data  Facilities_and_Administration_Rate_Agreement_Data  [0..1]  The Rate Agreement's Data element, containing the instances and attributes pertaining to it. 
Validation Description
The Rate Agreement Name & Date combination already exists.   
Can't delete Cost Rate Types that are tied to Award Lines.   
 
Validation Description
The Web Service is set to Add Only; but the Rate Agreement already exists.   
top
 

Response Element: Put_Facilities_and_Administration_Rate_Agreement_Response

Facilities and Administration Rate Agreement Reference
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Facilities_and_Administration_Rate_Agreement_Reference  Facilities_and_Admin_Rate_AgreementObject  [0..1]  Facilities and Administration Rate Agreement Reference   
top
 

Facilities_and_Admin_Rate_AgreementObject

part of: Put_Facilities_and_Administration_Rate_Agreement_Request, Put_Facilities_and_Administration_Rate_Agreement_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  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_Data

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

Facilities_and_Admin_Basis_TypeObject

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

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