Service Directory > v32.1 > Revenue_Management > Get_Award_Additional_Data
 

Operation: Get_Award_Additional_Data

Enables retrieval of custom objects for the award.


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

Contains the award additional data request data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Award_Contract_Additional_Data_Request_References  [0..1]  This element contains the specific instance set containing the requested awards. The type attribute is either Reference ID type or Workday ID (GUID) and the ID is the value for the instance of the award. 
Validation Description
You can’t get custom objects for award amendments or historical awards.  You can’t get custom objects for award amendments or historical awards. 
 
Request_Criteria [Choice]   Award_Contract_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the award-specific criteria needed to search for instances. All of the elements are "AND" conditions.   
Response_Filter  Response_Filter  [0..1]  Parameters that enable you to 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. 
 
top
 

Response Element: Get_Award_Additional_Data_Response

Element containing award additional data 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  Award_Contract_Additional_Data_Request_References  [0..1]  This element contains the specific instance set containing the requested awards. The type attribute is either Reference ID type or Workday ID (GUID) and the ID is the value for the instance of the award. 
Validation Description
You can’t get custom objects for award amendments or historical awards.  You can’t get custom objects for award amendments or historical awards. 
 
Request_Criteria  Award_Contract_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the award-specific criteria needed to search for instances. All of the elements are "AND" conditions.   
Request_Filter  Response_Filter  [0..1]  Parameters that enable you to 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. 
 
Request_Results  Response_Results  [0..1]  This 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  Award_Additional_Data_Response_Data  [0..1]  This element contains the award additional data response data.   
top
 

Award_Contract_Additional_Data_Request_References

part of: Get_Award_Additional_Data_Response, Get_Award_Additional_Data_Request
This element contains the specific instance set containing the requested awards. The type attribute is either Reference ID type or Workday ID (GUID) and the ID is the value for the instance of the award.
 
Parameter name Type/Value Cardinality Description Validations
Award_Reference  Award_Contract_AbstractObject  [1..*]  The award reference.   
Validation Description
You can’t get custom objects for award amendments or historical awards.  You can’t get custom objects for award amendments or historical awards. 
top
 

Award_Contract_AbstractObject

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

Award_Contract_AbstractObjectID

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

Award_Contract_Request_Criteria

part of: Get_Award_Additional_Data_Response, Get_Award_Additional_Data_Request
This element is the wrapper around a list of elements representing the Award specific criteria needed to search for instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
Sponsor_Reference  SponsorObject  [0..*]  Awards with a Sponsor in this set will be returned.   
Award_Name  string  [0..1]  Name of the Award to return   
Award_Reference_ID  string  [0..1]  ID of the Award to Return   
Company_Reference  CompanyObject  [0..1]  Awards that are for this Company will be returned.   
Award_Status_Reference  Document_StatusObject  [0..*]  Awards with one of the specified Statuses will be returned.   
Award_Effective_Date_On_or_After  date  [0..1]  Awards with an Effective date on or after this date will be returned.   
Award_Effective_Date_On_or_Before  date  [0..1]  Awards with an Effective Date on or before this date will be returned.   
top
 

SponsorObject

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

SponsorObjectID

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

CompanyObject

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

Document_StatusObject

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

Document_StatusObjectID

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

Response_Results

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

Award_Additional_Data_Response_Data

part of: Get_Award_Additional_Data_Response
This element contains the award additional data response data.
 
Parameter name Type/Value Cardinality Description Validations
Award_Custom_Object_Data  Award_Custom_Object_Data  [0..*]  Wrapper element containing the award additional data for requested references or criteria, and for requested response group. 
Validation Description
You can’t submit custom objects for award amendments or historical awards.  You can’t submit custom objects for award amendments or historical awards. 
 
top
 

Award_Custom_Object_Data

part of: Award_Additional_Data_Response_Data
Wrapper element containing the award additional data for requested references or criteria, and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
Award_Reference  Award_Contract_AbstractObject  [0..1]  The award reference.   
Business_Object_Additional_Data  Non_Effective_Dated_Web_Service_Additional_Data  [0..1]  The award additional data.   
Validation Description
You can’t submit custom objects for award amendments or historical awards.  You can’t submit custom objects for award amendments or historical awards. 
top
 

Non_Effective_Dated_Web_Service_Additional_Data

part of: Award_Custom_Object_Data
Non Effective Dated Web Service Additional Data
 
Parameter name Type/Value Cardinality Description Validations
top
 

Award_Contract_AbstractReferenceEnumeration

part of: Award_Contract_AbstractObjectID
Base Type
string
top
 

SponsorReferenceEnumeration

part of: SponsorObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top