Service Directory > v32.1 > Staffing > Get_Collective_Agreements
 

Operation: Get_Collective_Agreements

Retrieves all collective agreements specified in the request.


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

Get Collective Agreements Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Collective_Agreement_Request_References  [0..1]  Collective Agreement Request References Element   
Request_Criteria [Choice]   Collective_Agreement_Request_Criteria  [0..1]  Collective Agreement Request Criteria Element   
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  Collective_Agreement_Response_Group  [0..1]  Collective Agreement Response Group Element   
top
 

Response Element: Get_Collective_Agreements_Response

Get Collective Agreements Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Collective_Agreement_Request_References  [0..1]  Collective Agreement Request References Element   
Request_Criteria  Collective_Agreement_Request_Criteria  [0..1]  Collective Agreement Request Criteria Element   
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  Collective_Agreement_Response_Group  [0..1]  Collective Agreement Response Group Element   
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  Collective_Agreement_Response_Data  [0..1]  Collective Agreement Response Data Element   
top
 

Collective_Agreement_Request_References

part of: Get_Collective_Agreements_Request, Get_Collective_Agreements_Response
Collective Agreement Request References Element
 
Parameter name Type/Value Cardinality Description Validations
Collective_Agreement_Reference  Collective_AgreementObject  [1..*]  Collective Agreement Request References Workset   
top
 

Collective_AgreementObject

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

Collective_AgreementObjectID

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

Collective_Agreement_Request_Criteria

part of: Get_Collective_Agreements_Request, Get_Collective_Agreements_Response
Collective Agreement Request Criteria Element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Collective_Agreements_Request, Get_Collective_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
 

Collective_Agreement_Response_Group

part of: Get_Collective_Agreements_Request, Get_Collective_Agreements_Response
Collective Agreement Response Group Element
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Included Reference boolean element   
top
 

Response_Results

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

Collective_Agreement_Response_Data

part of: Get_Collective_Agreements_Response
Collective Agreement Response Data Element
 
Parameter name Type/Value Cardinality Description Validations
Collective_Agreement  Collective_Agreement  [0..*]  Collective Agreement Element   
top
 

Collective_Agreement

part of: Collective_Agreement_Response_Data
Collective Agreement Element
 
Parameter name Type/Value Cardinality Description Validations
Collective_Agreement_Reference  Collective_AgreementObject  [0..1]  Collective Agreement Instance   
Collective_Agreement_Data  Collective_Agreement_Data  [0..*]  Collective Agreement Data Element 
Validation Description
Each set of classification factor values must be unique. Change a value or delete the row.   
 
top
 

Collective_Agreement_Data

part of: Collective_Agreement
Collective Agreement Data Element
 
Parameter name Type/Value Cardinality Description Validations
Agreement  string  [1..1]  Agreement Text   
ID  string  [1..1]  ID Text   
Code  string  [0..1]  Code Text   
Start_Date  date  [0..1]  Start Date 
Validation Description
The field Start Date is required and must have a value.   
 
End_Date  date  [0..1]  End Date 
Validation Description
Start Date must be before End Date.   
 
Restricted_to_Countries_Reference  CountryObject  [0..*]  Restricted to Countries   
Location_Reference  LocationObject  [0..*]  Location 
Validation Description
Invalid Location selection for Restricted to Countries selections   
 
Union_Reference  UnionObject  [0..*]  Union   
Note  string  [0..1]  Note Text   
Inactive  boolean  [0..1]  Inactive Boolean   
Collective_Agreement_Factors_Mapping  Collective_Agreement_Factors_Mapping  [0..1]  Collective Agreement Factors Mapping Element 
Validation Description
The Collective Agreement Factors cannot be modified as the Collective Agreement is in use.   
The Collective Agreement Factors cannot be modified as the Collective Agreement is in use.   
 
Collective_Agreement_Classification_Parameters  Collective_Agreement_Classification_Parameters  [0..*]  Collective Agreement Classification Parameters Element   
Validation Description
Each set of classification factor values must be unique. Change a value or delete the row.   
top
 

CountryObject

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

LocationObject

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

LocationObjectID

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

UnionObject

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

UnionObjectID

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

Collective_Agreement_Factors_Mapping

part of: Collective_Agreement_Data
Collective Agreement Factors Mapping Element
 
Parameter name Type/Value Cardinality Description Validations
Factor1_Reference  Collective_Agreement_FactorObject  [0..1]  Factor 1 
Validation Description
[Collective Agreement Factor] can be used only once. Select another factor.   
Select a factor or rearrange your other factor(s) so that this factor is not blank.   
 
Factor2_Reference  Collective_Agreement_FactorObject  [0..1]  Factor 2 
Validation Description
Select a factor or rearrange your other factor(s) so that this factor is not blank.   
[Collective Agreement Factor] can be used only once. Select another factor.   
 
Factor3_Reference  Collective_Agreement_FactorObject  [0..1]  Factor 3 
Validation Description
[Collective Agreement Factor] can be used only once. Select another factor.   
Select a factor or rearrange your other factor(s) so that this factor is not blank.   
 
Factor4_Reference  Collective_Agreement_FactorObject  [0..1]  Factor 4 
Validation Description
[Collective Agreement Factor] can be used only once. Select another factor.   
Select a factor or rearrange your other factor(s) so that this factor is not blank.   
 
Factor5_Reference  Collective_Agreement_FactorObject  [0..1]  Factor 5 
Validation Description
[Collective Agreement Factor] can be used only once. Select another factor.   
 
top
 

Collective_Agreement_FactorObject

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

Collective_Agreement_FactorObjectID

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

Collective_Agreement_Classification_Parameters

part of: Collective_Agreement_Data
Collective Agreement Classification Parameters Element
 
Parameter name Type/Value Cardinality Description Validations
Collective_Agreement_Classification_Parameter_Reference  Collective_Agreement_Classification_ParameterObject  [0..1]  Collective Agreement Classification Parameter Reference   
ID  string  [0..1]  ID Text   
Factor_Option1_Reference  Collective_Agreement_Factor_OptionObject  [0..1]  Factor Option 1 
Validation Description
Collective Agreement Factor Option, [cafo] doesn't belong to the Collective Agreement Factor, [caf] or is Inactive. Please Enter a valid Collective Agreement Factor Option.   
 
Factor_Option2_Reference  Collective_Agreement_Factor_OptionObject  [0..1]  Factor Option 2 
Validation Description
Collective Agreement Factor Option, [cafo] doesn't belong to the Collective Agreement Factor, [caf] or is Inactive. Please Enter a valid Collective Agreement Factor Option.   
 
Factor_Option3_Reference  Collective_Agreement_Factor_OptionObject  [0..1]  Factor Option 3 
Validation Description
Collective Agreement Factor Option, [cafo] doesn't belong to the Collective Agreement Factor, [caf] or is Inactive. Please Enter a valid Collective Agreement Factor Option.   
 
Factor_Option4_Reference  Collective_Agreement_Factor_OptionObject  [0..1]  Factor Option 4 
Validation Description
Collective Agreement Factor Option, [cafo] doesn't belong to the Collective Agreement Factor, [caf] or is Inactive. Please Enter a valid Collective Agreement Factor Option.   
 
Factor_Option5_Reference  Collective_Agreement_Factor_OptionObject  [0..1]  Factor Option 5 
Validation Description
Collective Agreement Factor Option, [cafo] doesn't belong to the Collective Agreement Factor, [caf] or is Inactive. Please Enter a valid Collective Agreement Factor Option.   
 
Inactive  boolean  [0..1]  Inactive Boolean   
top
 

Collective_Agreement_Classification_ParameterObject

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

Collective_Agreement_Classification_ParameterObjectID

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

Collective_Agreement_Factor_OptionObject

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

Collective_Agreement_Factor_OptionObjectID

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

Collective_AgreementReferenceEnumeration

part of: Collective_AgreementObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

UnionReferenceEnumeration

part of: UnionObjectID
Base Type
string
top
 

Collective_Agreement_FactorReferenceEnumeration

part of: Collective_Agreement_FactorObjectID
Base Type
string
top
 

Collective_Agreement_Classification_ParameterReferenceEnumeration

part of: Collective_Agreement_Classification_ParameterObjectID
Base Type
string
top
 

Collective_Agreement_Factor_OptionReferenceEnumeration

part of: Collective_Agreement_Factor_OptionObjectID
Base Type
string
top