Service Directory > v31.2 > Staffing > Put_Worker_Document
 

Operation: Put_Worker_Document

Adds or updates a worker document. The operation adds documents not associated with events and those documents are not secured by the events.


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

Request element for Put Worker Document/
 
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.   
Worker_Document_Reference  Worker_DocumentObject  [0..1]  The reference to the worker document.   
Worker_Document_Data  Worker_Document_Data  [1..1]  Wrapper element for the details of a worker document.   
Validation Description
Worker Document, '[document]', already exists.   
top
 

Response Element: Put_Worker_Document_Response

Response element for Put Worker Document.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Document_Reference  Worker_DocumentObject  [0..1]  The reference to the worker document.   
top
 

Worker_DocumentObject

part of: Put_Worker_Document_Request, Put_Worker_Document_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  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
 

Worker_Document_Data

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