Service Directory > v31.2 > Staffing > Get_Notice_Periods
 

Operation: Get_Notice_Periods

Returns employer and employee notice periods for a notice period target


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

Get Notice Periods for a single Notice Period Target (Employee). Returns employer and employee notice periods.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_Notice_Periods_Request_References  [0..1]  Notice Period Target Reference. 
Validation Description
Your notice period localization settings for [country] are turned off. Activate notice period localization settings for [country] in the Maintain Localization Settings task to enable notice period rules for [country].   
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Notice_Periods_for_Notice_Period_Target_Response

Contains the employer/employee Notice Period response data specific to the Notice Period Target request and As Of Effective Date.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_Notice_Periods_Request_References  [0..1]  Contains a single reference to a Notice Period Target. 
Validation Description
Your notice period localization settings for [country] are turned off. Activate notice period localization settings for [country] in the Maintain Localization Settings task to enable notice period rules for [country].   
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Get_Notice_Periods_Response_Data  [0..1]  Contains the employer/employee Notice Period response data specific to the Notice Period Target request and As Of Effective Date.   
top
 

Get_Notice_Periods_Request_References

part of: Get_Notice_Periods_Request, Get_Notice_Periods_for_Notice_Period_Target_Response
Contains a single reference to a Notice Period Target.
 
Parameter name Type/Value Cardinality Description Validations
Notice_Period_Target_Reference  Notice_Period_TargetObject  [1..1]  Reference to a Notice Period Target.   
Validation Description
Your notice period localization settings for [country] are turned off. Activate notice period localization settings for [country] in the Maintain Localization Settings task to enable notice period rules for [country].   
top
 

Notice_Period_TargetObject

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

Notice_Period_TargetObjectID

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

Response_Filter

part of: Get_Notice_Periods_Request, Get_Notice_Periods_for_Notice_Period_Target_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Notice_Periods_for_Notice_Period_Target_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Get_Notice_Periods_Response_Data

part of: Get_Notice_Periods_for_Notice_Period_Target_Response
Contains the employer/employee Notice Period response data specific to the Notice Period Target request and As Of Effective Date.
 
Parameter name Type/Value Cardinality Description Validations
Notice_Period_Data_for_Notice_Period_Target  Notice_Period_Data_for_Notice_Period_Target  [0..*]  Contains the employer/employee Notice Period response data specific to the Notice Period Target request and As Of Effective Date.   
top
 

Notice_Period_Data_for_Notice_Period_Target

part of: Get_Notice_Periods_Response_Data
Contains the employer/employee Notice Period response data specific to the Notice Period Target request and As Of Effective Date.
 
Parameter name Type/Value Cardinality Description Validations
Notice_Period_Target_Reference  Notice_Period_TargetObject  [0..1]  Notice Period Target Reference.   
Location_Reference  LocationObject  [0..1]  Primary location (for supervisory organizations) is effective dated.   
Employer_Notice_Period_Data  Notice_Period_Data_-_Employer  [0..*]  Notice Period Data for an employer notice period.   
Employee_Notice_Period_Data  Notice_Period_Data_-_Employee  [0..*]  Notice Period Data for an employee notice period.   
top
 

LocationObject

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

LocationObjectID

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

Notice_Period_Data_-_Employer

part of: Notice_Period_Data_for_Notice_Period_Target
Notice Period data for an employer.
 
Parameter name Type/Value Cardinality Description Validations
Notice_Period_Data  Notice_Period_Data  [0..*]  Detail notice period data for employer and employee.   
top
 

Notice_Period_Data

part of: Notice_Period_Data_-_Employer, Notice_Period_Data_-_Employee
Detail notice period data for employer and employee.
 
Parameter name Type/Value Cardinality Description Validations
Notice_Period_Reference  Unique_IdentifierObject  [0..1]  Notice Period From   
Notice_Period_Duration  decimal (20, 0) >0   [0..1]  Notice Period Duration   
Notice_Period_Unit_Reference  Unique_IdentifierObject  [0..1]  Notice Period Unit   
Date_And_Time_Adjustment_Reference  Unique_IdentifierObject  [0..1]  Notice Period Adjustment   
Notice_Period_Is_Custom  boolean  [0..1]  The notice period presented is a custom notice period.   
Overridden_Notice_Period_Reference  Unique_IdentifierObject  [0..1]  Reference to the Notice Period that was overridden by a custom Notice Period.   
top
 

Unique_IdentifierObject

part of: Notice_Period_Data, Notice_Period_Data, Notice_Period_Data, Notice_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  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
 

Notice_Period_Data_-_Employee

part of: Notice_Period_Data_for_Notice_Period_Target
Notice Period data specific to the Employee.
 
Parameter name Type/Value Cardinality Description Validations
Notice_Period_Data  Notice_Period_Data  [0..*]  Employee notice period data.   
top
 

Notice_Period_TargetReferenceEnumeration

part of: Notice_Period_TargetObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top