Service Directory > v31.2 > Staffing > Get_Worker_Documents
 

Operation: Get_Worker_Documents

Returns worker document data.


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

Request element for Get Worker Documents.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Worker_Document_Request_References  [0..1]  The Worker Document reference(s) to be retrieved.   
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_Document_Response_Group  [0..1]  Worker Document Response Group which controls the type and amount of data returned.   
top
 

Response Element: Get_Worker_Documents_Response

Response element for Get Worker Documents.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worker_Document_Request_References  [0..1]  The Worker Document reference(s) to be retrieved.   
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_Document_Response_Group  [0..1]  Worker Document Response Group which controls the type and amount of data returned.   
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_Document_Response_Data  [0..1]  Worker Document Response Data containing the retrieved Worker Document information.   
top
 

Worker_Document_Request_References

part of: Get_Worker_Documents_Request, Get_Worker_Documents_Response
The Worker Document reference(s) to be retrieved.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Document_Reference  Worker_DocumentObject  [1..*]  The reference to the worker document.   
top
 

Worker_DocumentObject

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

Worker_DocumentObjectID

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

Worker_Document_Response_Group

part of: Get_Worker_Documents_Request, Get_Worker_Documents_Response
Worker Document Response Group which controls the type and amount of data returned.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the reference to the Worker Document should be included. If omitted, the default is to return the references.   
Include_Worker_Document_Data  boolean  [0..1]  Flag indicating if the Worker Document Data should be included. If omitted, the default is to return the data.   
top
 

Response_Results

part of: Get_Worker_Documents_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_Document_Response_Data

part of: Get_Worker_Documents_Response
Worker Document Response Data containing the retrieved Worker Document information.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Document  Worker_Document  [0..*]  Contains the retrieved Worker Document information.   
top
 

Worker_Document

part of: Worker_Document_Response_Data
Contains the retrieved Worker Document information.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Document_Reference  Worker_DocumentObject  [0..1]  The reference to the worker document.   
Worker_Document_Data  Worker_Document_Data  [0..1]  The information about the worker document, such as the category and file.   
top
 

Worker_Document_Data

part of: Worker_Document
The information about the worker document, such as the category and file.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID for the worker document.   
Filename  string (255)   [1..1]  The name of the worker document file.   
Comment  string  [0..1]  A comment about the worker document.   
File  base64Binary  [0..1]  File content in base64 encoding.   
Document_Category_Reference  Document_Category__All_Object  [1..1]  The category that the worker document is for. 
Validation Description
The category "[cat]" is inactive and cannot be used.   
 
Worker_Reference  WorkerObject  [1..1]  Reference to a Role.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Document_Category__All_Object

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

Document_Category__All_ObjectID

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

WorkerObject

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

Worker_DocumentReferenceEnumeration

part of: Worker_DocumentObjectID
Base Type
string
top
 

Document_Category__All_ReferenceEnumeration

part of: Document_Category__All_ObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top