Service Directory > v31.2 > Human_Resources > Put_Former_Worker_Document
 

Operation: Put_Former_Worker_Document

Adds or updates a former 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_Former_Worker_Document_Request

Request element for Put Former Worker Document Request
 
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.   
Former_Worker_Document_Reference  Former_Worker_AttachmentObject  [0..1]  The reference to the former worker document.   
Former_Worker_Document_Data  Former_Worker_Attachment_Data  [1..1]  Wrapper element for the details of a former worker document.   
Validation Description
Former Worker Document, '[document]', already exists.   
Reference to former worker is required if adding a new former worker document   
Former worker document needs a name if adding a new document   
Document Category Reference is required when adding a new document.   
top
 

Response Element: Put_Former_Worker_Document_Response

Response Element for Put Former Worker Attachment
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Former_Worker_Attachment_Reference  Former_Worker_AttachmentObject  [0..1]  Reference for Former Worker Attachment   
Former_Worker_Reference  Former_WorkerObject  [0..1]  Reference to the former worker   
top
 

Former_Worker_AttachmentObject

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

Former_Worker_AttachmentObjectID

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

Former_Worker_Attachment_Data

part of: Put_Former_Worker_Document_Request
The information about the former worker document, such as the category and file.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID for the former worker document   
File_Name  string (255)   [0..1]  Attachment Filename   
File  base64Binary  [0..1]  Attachment File   
Former_Worker_Reference  Former_WorkerObject  [0..1]  Reference to the former worker   
Document_Category_Reference  Document_Category__All_Object  [0..1]  Category of the document. 
Validation Description
The category "[cat]" is inactive and cannot be used.   
 
Comment  string  [0..1]  Attachment File Comment   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the document.   
top
 

Former_WorkerObject

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

Former_WorkerObjectID

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

Document_Category__All_Object

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

Former_Worker_AttachmentReferenceEnumeration

part of: Former_Worker_AttachmentObjectID
Base Type
string
top
 

Former_WorkerReferenceEnumeration

part of: Former_WorkerObjectID
Base Type
string
top
 

Document_Category__All_ReferenceEnumeration

part of: Document_Category__All_ObjectID
Base Type
string
top