Service Directory > v31.2 > Revenue_Management > Put_Award_Schedule
 

Operation: Put_Award_Schedule

This service operation will add or update Award Schedules for use on Award Contracts. Award Schedule Data includes Award Schedule Reference ID, Award Schedule Name, Award Posting Interval Group, and Award Year Data. Award Year Data contains year-by-year information for the award schedule, including Award Year Name, Award Year Numer, and Award Period Data. Award Period Data contains information for a single period within an award year, including Award Posting Interval Name, Award Period Start Date, and Award Period End Date.


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

Element containing Award Schedule reference for update (or empty if a new Award Schedule is being added) and all Award Schedule data items.
 
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_Schedule_Reference  Award_ScheduleObject  [0..1]  Reference to an existing Award Schedule for update purposes only.   
Award_Schedule_Data  Award_Schedule_Data  [0..1]  Award Schedule Data for the single award schedule being created or updated. 
Validation Description
Select only one Contract Start Date and one Contract End Date.   
Enter a Contract Start Date that is before the Contract End Date.   
 
Validation Description
Award Schedule Exists where the web service is set to Add Only.   
top
 

Response Element: Put_Award_Schedule_Response

Element containing Put Award Schedule Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Award_Schedule_Reference  Award_ScheduleObject  [0..1]  Reference to the Award Schedule that was Created or Updated by this Put operation   
top
 

Award_ScheduleObject

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

Award_ScheduleObjectID

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

part of: Put_Award_Schedule_Request
Contains all References and Attributes to represent a complete Award Schedule.
 
Parameter name Type/Value Cardinality Description Validations
Award_Schedule_Reference_ID  string  [0..1]  Award Schedule Reference ID. This is the Award Schedule Unique Identifier.   
Award_Schedule_Name  string  [1..1]  Award Schedule Name   
Award_Posting_Interval_Group_Reference  Award_Posting_Interval_GroupObject  [1..*]  A reference to the Award Posting Interval Group for the Award Schedule. The Award Posting Interval Group indicates the interval information (periods per year) for the Award Schedule.   
Award_Period_Data  Award_Year_Data  [0..*]  Encapsulating element for information describing an Award Period 
Validation Description
Enter a Period Name that isn't already in use.   
Enter an Award Period Number that isn't already in use.   
Award Period must contain all the Posting Interval Names from the Award Posting Interval Group.   
 
Validation Description
Select only one Contract Start Date and one Contract End Date.   
Enter a Contract Start Date that is before the Contract End Date.   
top
 

Award_Posting_Interval_GroupObject

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

Award_Posting_Interval_GroupObjectID

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

part of: Award_Schedule_Data
Award Period Data contains all information describing a single period of the Award Schedule.
 
Parameter name Type/Value Cardinality Description Validations
Award_Period_Reference_ID  string  [0..1]  Award Period Reference ID. This is the Award Period unique identifier.   
Award_Period_Name  string  [1..1]  Award Period Name   
Award_Period_Number  decimal (4, 0) >0   [1..1]  Award Period Number   
Award_Interval_Data  Award_Period_Data  [0..*]  Award Interval Data Element 
Validation Description
Enter a Start Date that is before the end date.   
Award Intervals cannot overlap.   
There cannot be any gaps between Award Intervals.   
 
Is_Award_Contract_Start_Date  boolean  [0..1]  The Award Period End Date is Award Contract End Date.   
Is_Award_Contract_End_Date  boolean  [0..1]  The Award Period Start Date is Award Contract Start Date.   
Validation Description
Enter a Period Name that isn't already in use.   
Enter an Award Period Number that isn't already in use.   
Award Period must contain all the Posting Interval Names from the Award Posting Interval Group.   
top
 

Award_Period_Data

part of: Award_Year_Data
Award Period Data contains all information describing a single Period within the Award Year
 
Parameter name Type/Value Cardinality Description Validations
Award_Posting_Interval_Reference  Award_Posting_IntervalObject  [0..1]  The Award Positing Interval for the Award Period   
Award_Posting_Interval_ID  string  [0..1]  The Award Positing Interval Reference Id for the Award Period   
Award_Posting_Interval_Name_Reference  Award_Posting_Interval_NameObject  [1..1]  A Reference to the Award Posting Interval Name for the Award Period. Award Posting Interval Names are defined by the Award Posting Interval Group for the Award Schedule. 
Validation Description
Enter a Posting Interval that is after the previous posting interval. The interval [current] isn't after the interval [previous].   
 
Award_Interval_Start_Date  date  [0..1]  The Start Date of Award Interval   
Award_Interval_End_Date  date  [0..1]  The End Date of Award Interval   
Validation Description
Enter a Start Date that is before the end date.   
Award Intervals cannot overlap.   
There cannot be any gaps between Award Intervals.   
top
 

Award_Posting_IntervalObject

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

Award_Posting_IntervalObjectID

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

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

Award_Posting_Interval_NameObjectID

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

part of: Award_ScheduleObjectID
Base Type
string
top
 

Award_Posting_Interval_GroupReferenceEnumeration

part of: Award_Posting_Interval_GroupObjectID
Base Type
string
top
 

Award_Posting_IntervalReferenceEnumeration

part of: Award_Posting_IntervalObjectID
Base Type
string
top
 

Award_Posting_Interval_NameReferenceEnumeration

part of: Award_Posting_Interval_NameObjectID
Base Type
string
top