Service Directory > v32.1 > Revenue_Management > Put_Award_Lifecycle_Status
 

Operation: Put_Award_Lifecycle_Status

This service operation will add or update Award Lifecycle Statuses. Award Lifecycle Status Data includes Award Lifecycle Status Reference ID, Award Lifecycle Status Name, Award Lifecycle Status Valid at Award, Award Lifecycle Status Valid at Award Line, Award Lifecycle Status Default at Award, Award Lifecycle Status Default at Award Line, and Award Lifecycle Status 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_Lifecycle_Status_Request

Element containing Award Lifecycle Status reference for update (or empty if a new Award Lifecycle Status is being added).
 
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.   
Award_Lifecycle_Status_Reference  Award_Lifecycle_StatusObject  [0..1]  Reference to an existing Award Lifecycle Status for update purposes only.   
Award_Lifecycle_Status_Data  Award_Lifecycle_Status_Data  [0..1]  Award Lifecycle Status Data for the single award lifecycle status being created or updated.   
Validation Description
The Web Service is set to Add Only, but the Award Lifecycle Status already exists.  Flag as an error the condition where an already-existing award lifecycle status is sent in add-only mode. 
top
 

Response Element: Put_Award_Lifecycle_Status_Response

Element containing Submit Award Lifecycle Status Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Award_Lifecycle_Status_Reference  Award_Lifecycle_StatusObject  [0..1]  Reference to the Award Lifecycle Status that was created or updated by this Submit operation   
top
 

Award_Lifecycle_StatusObject

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

Award_Lifecycle_StatusObjectID

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

Award_Lifecycle_Status_Data

part of: Put_Award_Lifecycle_Status_Request
Contains all References and Attributes to represent a complete Award Lifecycle Status.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Award Lifecycle Status Reference ID. This is the Award Lifecycle Status Unique Identifier.   
Award_Lifecycle_Status_Name  string  [1..1]  The Award Lifecycle Status Name. 
Validation Description
Enter an Award Lifecycle Status that isn't already in use.  Enter an Award Lifecycle Status that isn't already in use. 
You cannot change the Award Lifecycle Status because it's already in use.  You cannot change the Award Lifecycle Status because it's already in use. 
 
Award_Lifecycle_Status_Valid_for_Award  boolean  [0..1]  The Award Lifecycle Status Valid for Header flag. 
Validation Description
You cannot change the Valid for Award selection because the Award Lifecycle Status is in use.  You cannot change the Valid for Award selection because the Award Lifecycle Status is in use. 
 
Award_Lifecycle_Status_Valid_for_Award_Line  boolean  [0..1]  The Award Lifecycle Status Valid for Award Line flag. 
Validation Description
You cannot change the Valid for Award line selection because the Award Lifecycle Status is in use.  You cannot change the Valid for Award line selection because the Award Lifecycle Status is in use. 
 
Award_Lifecycle_Status_Default_for_Award  boolean  [0..1]  The Award Lifecycle Status Default for Award flag. 
Validation Description
Select 1 Award Lifecycle Status to use as the default on new awards.  Select 1 Award Lifecycle Status to use as the default on new awards. 
You cannot set an inactive Award Lifecycle Status as the default for an award.  You cannot set an inactive Award Lifecycle Status as the default for an award. 
You cannot set an Award Lifecycle Status that is invalid for the award as the default.  You cannot set an Award Lifecycle Status that is invalid for the award as the default. 
 
Award_Lifecycle_Status_Default_for_Award_Line  boolean  [0..1]  The Award Lifecycle Status Default for Award Line flag. 
Validation Description
Select 1 Award Lifecycle Status to use as the default on new award lines.  Select 1 Award Lifecycle Status to use as the default on new award lines. 
You cannot set an inactive Award Line Lifecycle Status as the default for an award line.  You cannot set an inactive Award Line Lifecycle Status as the default for an award line. 
You cannot set an Award Line Lifecycle Status that is invalid for the award line as the default.  You cannot set an Award Line Lifecycle Status that is invalid for the award line as the default. 
 
Award_Lifecycle_Status_Inactive  boolean  [0..1]  The Award Lifecycle Status Inactive flag.   
top
 

Award_Lifecycle_StatusReferenceEnumeration

part of: Award_Lifecycle_StatusObjectID
Base Type
string
top