Service Directory > v32.1 > Revenue_Management > Put_Award_Credit_Definition
 

Operation: Put_Award_Credit_Definition

This web service operation adds or updates award credit definitions. Award credit definition data includes Award Credit Definition Reference, Award Credit Definition ID, Award Credit Definition Name, Award Credit Definition Description, Required Worktag Type Reference, Optional Worktag Type Reference, Managing Company Reference, and Inactive.


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

Submit a request to add or update an award credit definition.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  True if you're adding a new award credit definition.   
Award_Credit_Definition_Reference  Award_Credit_DefinitionObject  [0..1]  Enter the award credit definition reference you'd like to update. Workday creates a new award credit definition if you don't specify one.   
Award_Credit_Definition_Data  Award_Credit_Definition_Data  [0..1]  Award Credit Definition Data for the single award credit definition being created or updated.   
Validation Description
When creating a new award credit definition, set the Add Only field to True. When updating an existing award credit definition, set the Add Only field to False and enter the award credit definition reference or the award credit definition ID.   
top
 

Response Element: Put_Award_Credit_Definition_Response

Response for the put operation. It contains the single award credit definition.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Award_Credit_Definition_Reference  Award_Credit_DefinitionObject  [0..1]  Reference to the Award Credit Definition that was created or updated by this Put operation   
top
 

Award_Credit_DefinitionObject

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

Award_Credit_DefinitionObjectID

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

part of: Put_Award_Credit_Definition_Request
Enter the award credit definition data.
 
Parameter name Type/Value Cardinality Description Validations
Award_Credit_Definition_ID  string  [0..1]  Enter the award credit definition ID.   
Award_Credit_Definition_Name  string  [0..1]  Enter the award credit definition name. 
Validation Description
Enter an award credit definition name that does not already exist.  Enter an award credit definition name that does not already exist. 
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Award_Credit_Definition_Description  string  [0..1]  Enter the award credit definition description. 
Validation Description
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Required_Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..*]  Enter the required worktag types for the award credit definition. 
Validation Description
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Optional_Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..*]  Enter the optional worktag types for the award credit definition. 
Validation Description
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Managing_Company_Reference  CompanyObject  [0..*]  Enter the managing company for the award credit definition. 
Validation Description
You can't edit award credit definitions that are in use.  You can't edit award credit definitions that are in use. 
 
Inactive  boolean  [0..1]  True if the award credit definition is inactive.   
top
 

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

CompanyObject

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

Award_Credit_DefinitionReferenceEnumeration

part of: Award_Credit_DefinitionObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top