Service Directory > v32.1 > Recruiting > Put_Candidate_Attachment
 

Operation: Put_Candidate_Attachment

This operation adds an attachment to a Candidate and/or a Candidate's Job Application.


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

Contains a Candidate and/or Job Application to add Attachments to.
 
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. If an existing instance is found and this flag is set there will be an error.   
Candidate_Reference  CandidateObject  [0..1]  Reference to a Candidate.   
Prospect_Resume_Attachments_Data  Prospect_Attachments_Data  [0..1]  Resume/Cover Letter Attachments for prospect   
Candidate_Attachment_Data  Candidate_Attachment_Data  [0..1]  Contains information about a Attachment to add to a Candidate. 
Validation Description
File ID for the attachment already in use.   
 
Job_Application_Attachment_Data  Job_Application_Attachment_Data  [0..*]  Contains Information about the Job Application to update and Attachment to be added. 
Validation Description
Attachment with that filename already exists on the Job Application.   
A Job Application or Job Requisition Reference is required to add an Job Application Attachment.   
Duplicate filenames for the same job application are not permitted.   
Reference IDs must be unique.   
File ID for the attachment already in use.   
 
Validation Description
The Web Service is set to Add Only; but the Candidate Attachment already exists.   
Enter the Filename and File Content for the document you want to attach.   
There is information in the Candidate/Prospect section that is missing a Candidate ID. Either delete the row or enter a Candidate ID.   
top
 

Response Element: Put_Candidate_Attachment_Response

Contains information about about the Candidate and/or Job Application the attachment was added to.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Candidate_Reference  CandidateObject  [0..1]  Reference to a Candidate.   
Attachment_Reference  Candidate_AttachmentObject  [0..*]  Reference for a Candidate Attachment.   
Job_Application_Attachment_Data  Job_Application_Attachment_Response  [0..*]  Contains information about the Job Application the Attachment was added to.   
Prospect_Resume_Attachment_Data  Prospect_Attachments_Data  [0..1]  Resume/Cover Letter Attachments for prospect   
top
 

CandidateObject

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

CandidateObjectID

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

Prospect_Attachments_Data

part of: Put_Candidate_Attachment_Request, Put_Candidate_Attachment_Response
Resume/Cover Letter Attachments for prospect
 
Parameter name Type/Value Cardinality Description Validations
Resume_Attachments  Attachment_WWS_Data  [0..*]  Attachment WWS Data element   
top
 

Attachment_WWS_Data

part of: Candidate_Attachment_Data, Job_Application_Attachment_Data, Prospect_Attachments_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

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

Mime_TypeObjectID

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

Candidate_Attachment_Data

part of: Put_Candidate_Attachment_Request
Contains information about a Attachment to add to a Candidate.
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Attachment_Reference  Candidate_AttachmentObject  [0..1]  Reference for a Candidate Attachment.   
Attachment_Data  Attachment_WWS_Data  [0..1]  Attachment WWS Data element   
Document_Category_Reference  Document_Category__All_Object  [1..1]  Identifies the category for the document.   
Validation Description
File ID for the attachment already in use.   
top
 

Candidate_AttachmentObject

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

Candidate_AttachmentObjectID

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

Document_Category__All_Object

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

Job_Application_Attachment_Data

part of: Put_Candidate_Attachment_Request
Contains Information about the Job Application to update and Attachment to be added.
 
Parameter name Type/Value Cardinality Description Validations
Job_Requisition_Reference  Job_RequisitionObject  [0..1]  Contains information about the candidate and their photo.   
Job_Application_Reference  Job_ApplicationObject  [0..1]  Reference for a Job Application.   
Attachment_Data  Attachment_WWS_Data  [1..1]  Attachment WWS Data element 
Validation Description
No Job Application for [jobreq] found for [candidate].   
 
Validation Description
Attachment with that filename already exists on the Job Application.   
A Job Application or Job Requisition Reference is required to add an Job Application Attachment.   
Duplicate filenames for the same job application are not permitted.   
Reference IDs must be unique.   
File ID for the attachment already in use.   
top
 

Job_RequisitionObject

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

Job_RequisitionObjectID

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

Job_ApplicationObject

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

Job_ApplicationObjectID

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

Job_Application_Attachment_Response

part of: Put_Candidate_Attachment_Response
Contains information about the Job Application the Attachment was added to.
 
Parameter name Type/Value Cardinality Description Validations
Job_Application_Reference  Job_ApplicationObject  [0..1]  Reference for a Job Application.   
Job_Application_Attachment_Reference  Resume_AttachmentObject  [0..*]  Reference to the Attachments added to the Job Application.   
Job_Applications_Updated  string  [0..1]  Additional Job Applications updated.   
top
 

Resume_AttachmentObject

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

Resume_AttachmentObjectID

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

CandidateReferenceEnumeration

part of: CandidateObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top
 

Candidate_AttachmentReferenceEnumeration

part of: Candidate_AttachmentObjectID
Base Type
string
top
 

Document_Category__All_ReferenceEnumeration

part of: Document_Category__All_ObjectID
Base Type
string
top
 

Job_RequisitionReferenceEnumeration

part of: Job_RequisitionObjectID
Base Type
string
top
 

Job_ApplicationReferenceEnumeration

part of: Job_ApplicationObjectID
Base Type
string
top
 

Resume_AttachmentReferenceEnumeration

part of: Resume_AttachmentObjectID
Base Type
string
top