Service Directory > v31.2 > Human_Resources > Put_Period_Reporting_Calendar
 

Operation: Put_Period_Reporting_Calendar

This operation adds or updates a Period Reporting Calendar


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

Request Element for Adding or Updating a Period Reporting Calendar
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  If true, you're only allowed to add Period Reporting Calendars. No updates!   
Period_Reporting_Calendar_Reference  Period_Reporting_CalendarObject  [0..1]  Existing Period Reporting Calendar to Update   
Period_Reporting_Calendar_Data  Period_Reporting_Calendar_Data  [1..1]  Form to put, update, and view a Period Reporting Calendar   
Validation Description
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
Another Period Reporting Calendar with this name already exists   
top
 

Response Element: Put_Period_Reporting_Calendar_Response

Response of Put Period Reporting Calendar
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Period_Reporting_Calendar_Reference  Period_Reporting_CalendarObject  [0..1]  Updated/Created Period Reporting Calendar instance   
top
 

Period_Reporting_CalendarObject

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

Period_Reporting_CalendarObjectID

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

Period_Reporting_Calendar_Data

part of: Put_Period_Reporting_Calendar_Request
Form to put, update, and view a Period Reporting Calendar
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID of the Period Reporting Calendar   
Reporting_Calendar_Name  string  [1..1]  Period Reporting Calendar Name   
Academic_Unit_Reference  Academic_UnitObject  [0..*]  The Academic Units the Period Reporting Calendar is restricted to   
Default_Calendar  boolean  [0..1]  If true, the Period Reporting calendar is the default for the system or the academic unit 
Validation Description
You can't select the Default Calendar check box because the [calendar name] period reporting calendar is already defined as the default. To make this calendar the default, clear the check box on the other one.   
You can't select the Default Calendar check box because the [calendar name] period reporting calendar is already defined as the default. To make this calendar the default, clear the check box on the other one.   
An inactive Calendar cannot be designated as the Default.   
 
Inactive  boolean  [0..1]  if true, the Period Reporting Calendar is inactive   
Period_Reporting_Calendar_Row_Data  Period_Reporting_Calendar_Row_Data  [0..*]  Data per Period of the Period Reporting Calendar 
Validation Description
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
Enter the Period Reporting Calendar Row Reference for the reporting period row you want to delete.   
 
top
 

Academic_UnitObject

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

Academic_UnitObjectID

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

Period_Reporting_Calendar_Row_Data

part of: Period_Reporting_Calendar_Data
Period Reporting Row Data
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  States that this row is to be deleted   
@Add_Only  boolean  [1..1]  Determines if this row is a new row to add   
Order  string (6)   [1..1]  The order this period has   
ID  string  [0..1]  Reference ID of the Period Reporting Calendar Row   
Calendar_Period_Name  string  [1..1]  The Name of the Period. 
Validation Description
Name for the Calendar Row must be unique within the Calendar   
 
Academic_Period_Reference  Academic_PeriodObject  [0..1]  The academic period associated with this period row. (Is Optional!) 
Validation Description
For row # [order], the Academic Period's assigned Academic Unit must match the Calendar's Restricted to Academic Unit   
 
Start_Date  date  [1..1]  The Start Date of the evaluation period   
End_Date  date  [1..1]  The End Date of the evaluation period 
Validation Description
End Date must be after or on Start Date   
 
Evaluation_Constraint_Reference  Evaluation_ConstraintObject  [1..1]  The specification of how the status of a period is calculated based on the date range   
Validation Description
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
Enter the Period Reporting Calendar Row Reference for the reporting period row you want to delete.   
top
 

Academic_PeriodObject

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

Academic_PeriodObjectID

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

Evaluation_ConstraintObject

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

Evaluation_ConstraintObjectID

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

Period_Reporting_CalendarReferenceEnumeration

part of: Period_Reporting_CalendarObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Evaluation_ConstraintReferenceEnumeration

part of: Evaluation_ConstraintObjectID
Base Type
string
top