Service Directory > v31.2 > Payroll_GBR > Get_Worker_SSP_Work_Schedule_Calendars
 

Operation: Get_Worker_SSP_Work_Schedule_Calendars

This public web service operation returns Worker SSP Work Schedule Calendar data from Workday.


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

Get Worker SSP Work Schedule Calendars Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Worker_SSP_Work_Schedule_Calendar_Request_References  [0..1]  Worker SSP Work Schedule Calendar Request References   
Request_Criteria [Choice]   Worker_SSP_Work_Schedule_Calendar_Request_Criteria  [0..1]  Worker SSP Work Schedule Calendar Request Criteria   
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_Group  Worker_SSP_Work_Schedule_Calendar_Response_Group  [0..1]  Worker SSP Work Schedule Calendar Response Group   
top
 

Response Element: Get_Worker_SSP_Work_Schedule_Calendars_Response

Get Worker SSP Work Schedule Calendar Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worker_SSP_Work_Schedule_Calendar_Request_References  [0..1]  Worker SSP Work Schedule Calendar References   
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_Group  Worker_SSP_Work_Schedule_Calendar_Response_Group  [0..1]  Worker SSP Work Schedule Calendar Response Group   
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  Worker_SSP_Work_Schedule_Calendar_Response_Data  [0..1]  Worker SSP Work Schedule Calendar Response   
top
 

Worker_SSP_Work_Schedule_Calendar_Request_References

part of: Get_Worker_SSP_Work_Schedule_Calendars_Response, Get_Worker_SSP_Work_Schedule_Calendars_Request
Worker SSP Work Schedule Calendar Request References
 
Parameter name Type/Value Cardinality Description Validations
Worker_SSP_Work_Schedule_Calendar_Reference  Unique_IdentifierObject  [1..*]  Worker SSP Work Schedule Calendar References   
top
 

Unique_IdentifierObject

part of: Worker_SSP_Work_Schedule_Calendar_Request_References, Worker_SSP_Work_Schedule_Calendar
 
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
 

Worker_SSP_Work_Schedule_Calendar_Request_Criteria

part of: Get_Worker_SSP_Work_Schedule_Calendars_Request
Worker SSP Work Schedule Calendar Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Pay_Group_Reference [Choice]   Pay_GroupObject  [0..*]  Worker SSP Work Schedule Calendar Request Pay Groups   
Company_Reference [Choice]   CompanyObject  [0..*]  Worker SSP Work Schedule Calendar Request Companies   
top
 

Pay_GroupObject

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

Pay_GroupObjectID

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

CompanyObject

part of: Worker_SSP_Work_Schedule_Calendar_Data, Worker_SSP_Work_Schedule_Calendar_Request_Criteria
 
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
 

Response_Filter

part of: Get_Worker_SSP_Work_Schedule_Calendars_Response, Get_Worker_SSP_Work_Schedule_Calendars_Request
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
 

Worker_SSP_Work_Schedule_Calendar_Response_Group

part of: Get_Worker_SSP_Work_Schedule_Calendars_Response, Get_Worker_SSP_Work_Schedule_Calendars_Request
Worker SSP Work Schedule Calendar Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Worker SSP Work Schedule Calendar Reference in the Response   
top
 

Response_Results

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

Worker_SSP_Work_Schedule_Calendar_Response_Data

part of: Get_Worker_SSP_Work_Schedule_Calendars_Response
Worker SSP Work Schedule Calendar Response
 
Parameter name Type/Value Cardinality Description Validations
Worker_SSP_Work_Schedule_Calendar  Worker_SSP_Work_Schedule_Calendar  [0..*]  Worker SSP Work Schedule Calendar Data   
top
 

Worker_SSP_Work_Schedule_Calendar

part of: Worker_SSP_Work_Schedule_Calendar_Response_Data
Details for Worker SSP Work Schedule Calendar
 
Parameter name Type/Value Cardinality Description Validations
Worker_SSP_Work_Schedule_Calendar_Reference  Unique_IdentifierObject  [0..1]  Worker SSP Work Schedule Calendar Reference   
Worker_SSP_Work_Schedule_Calendar_Data  Worker_SSP_Work_Schedule_Calendar_Data  [0..*]  Worker SSP Work Schedule Calendar Data   
top
 

Worker_SSP_Work_Schedule_Calendar_Data

part of: Worker_SSP_Work_Schedule_Calendar
Details for Worker SSP Work Schedule Calendar
 
Parameter name Type/Value Cardinality Description Validations
Schedule_Effective_Date  date  [0..1]  Effective Date for this record   
Worker_Reference  WorkerObject  [0..1]  The Worker for this record   
Company_Reference  CompanyObject  [0..1]  Company for Worker of this record   
SSP_Work_Schedule_Calendar_Reference  SSP_Work_Schedule_CalendarObject  [0..1]  UK SSP Work Schedule Calendar   
Apply_Global_SSP_Work_Schedule_Calendar  boolean  [0..1]  Apply Global SSP Work Schedule Calendar Rule as of the Effective Date for the specified Worker and Company.   
top
 

WorkerObject

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

WorkerObjectID

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

SSP_Work_Schedule_CalendarObject

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

SSP_Work_Schedule_CalendarObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

SSP_Work_Schedule_CalendarReferenceEnumeration

part of: SSP_Work_Schedule_CalendarObjectID
Base Type
string
top