Service Directory > v25.1 > Talent > Manage_Awards
 

Operation: Manage_Awards

This operation allows adding new awards and editing existing awards for a worker.


@ - 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: Manage_Awards_Request

Request element for Manage Worker Award.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place.   
Manage_Awards_Data  Manage_Worker_Award_Data  [1..1]  Wrapper element for Award Data.   
top
 

Response Element: Manage_Awards_Response

Response element for Manage Worker Certification.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Award_Event_Reference  Unique_IdentifierObject  [0..1]  Reference to an instance of Worker Award Event   
Award_Reference  AwardObject  [0..*]  Reference to an instance of Education   
top
 

Business_Process_Parameters

part of: Manage_Awards_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Manage_Worker_Award_Data

part of: Manage_Awards_Request
Wrapper element for Award Data.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Reference to a worker.   
Source_Reference  Person_Skill_Source_CategoryObject  [0..1]  Reference to the source of the skill.   
Award  Award  [0..*]  Wrapper element for Award information.   
top
 

Person_Skill_Source_CategoryObject

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

Person_Skill_Source_CategoryObjectID

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

part of: Manage_Worker_Award_Data
Wrapper element for Award information.
 
Parameter name Type/Value Cardinality Description Validations
Award_Reference  AwardObject  [0..1]  Reference to the Award Profile.   
Award_Data  Award_Achievement_Data  [0..*]  Wrapper element for Award information. 
Validation Description
There is an in progress event for this worker for the award: [award]. Only one in progress event is allowed.  Only one change can be in progress (the event in progress and not complete or canceled) for an award for a particular worker. 
 
top
 

AwardObject

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

AwardObjectID

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

part of: Award
Wrapper element for Award information.
 
Parameter name Type/Value Cardinality Description Validations
Award_ID  string  [0..1]  Award ID. If no value is provided, a new award will be created. If a value is passed in and a corresponding award is not found, a new award will be created with the provided id.   
Remove_Award  boolean  [0..1]  Used for inbound operations to indicate that the award should be removed for the person. Will always return false for outbound operations. 
Validation Description
Remove Award is true without an Award or valid Award ID. An Award or valid Award ID must be specified in order to remove the Award.   
 
Award  string  [0..1]  The name of the award. Required unless the award is being removed. 
Validation Description
Award Name must be specified unless the award is being removed.   
 
Awarding_Body  string  [0..1]  The authority granting the award. Required unless the award is being removed. 
Validation Description
Awarding Body must be specified unless the award is being removed.   
 
Description  string  [0..1]  The description of the award.   
Date_Received  date  [0..1]  The date the award was received. Required unless the award is being removed. 
Validation Description
Date Received is required unless the award is being removed.   
 
Validation Description
There is an in progress event for this worker for the award: [award]. Only one in progress event is allowed.  Only one change can be in progress (the event in progress and not complete or canceled) for an award for a particular worker. 
top
 

Unique_IdentifierObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Person_Skill_Source_CategoryReferenceEnumeration

part of: Person_Skill_Source_CategoryObjectID
Base Type
string
top
 

AwardReferenceEnumeration

part of: AwardObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top