Service Directory > v31.2 > Human_Resources > Get_Person_Photos
 

Operation: Get_Person_Photos

Returns the person photo by Person Reference or Universal ID. It will filter out any person instances that are not enabled for photos.


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

Request element used to get the photo for a person.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria [Choice]   Person_Photo_Request_Criteria  [1..1]  Utilize the Request Criteria element to retrieve a specific instance or instances of Person and their associated photo. 
Validation Description
Unable to find a subject for this request. Please provide one using either Person Reference or Universal ID Reference.   
 
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. 
 
top
 

Response Element: Get_Person_Photos_Response

Element containing the Submit Person Photo response elements including request data and request criteria.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Person_Photo_Request_Criteria  [0..1]  Utilize the Request Criteria element to retrieve a specific instance or instances of Person and their associated photo. 
Validation Description
Unable to find a subject for this request. Please provide one using either Person Reference or Universal ID Reference.   
 
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_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  Person_Photo_Response_Data  [0..1]  Element containing the person data for the Get Person Photos response.   
top
 

Person_Photo_Request_Criteria

part of: Get_Person_Photos_Response, Get_Person_Photos_Request
Utilize the Request Criteria element to retrieve a specific instance or instances of Person and their associated photo.
 
Parameter name Type/Value Cardinality Description Validations
Person_Reference  RoleObject  [0..*]  A reference to the ID of a role associated with a person. Roles are like worker, student, external student etc. The ID consists of a type attribute which should be set to 'Employee_ID' or "Contingent_Worker_ID", for worker or 'Academic_Person_ID' for a student   
Universal_ID_Reference  Universal_IdentifierObject  [0..*]  A reference to the Universal ID for a person   
Validation Description
Unable to find a subject for this request. Please provide one using either Person Reference or Universal ID Reference.   
top
 

RoleObject

part of: Person_Photo_Request_Criteria, Change_Person_Photo_Data, Person_Photo
 
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  RoleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

RoleObjectID

part of: RoleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Contact_ID, Academic_Person_ID, Applicant_ID, Beneficiary_ID, Business_Entity_Contact_ID, Candidate_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Dependent_ID, Emergency_Contact_ID, Employee_ID, Extended_Enterprise_Contact_Person_ID, Extended_Enterprise_Learner_ID, External_Committee_Member_ID, Former_Worker_ID, Instructor_ID, Learning_Instructor_ID, LearningUserName, Organization_Reference_ID, Recruiting_Agency_User_ID, RecruitingUserName, Region_Reference_ID, Service_Center_Representative_ID, Student_ID, Student_Proxy_ID, Student_Recruiter_ID, StudentUserName, SupplierUserName, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [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
 

Universal_IdentifierObject

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

Universal_IdentifierObjectID

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

Response_Results

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

Person_Photo_Response_Data

part of: Get_Person_Photos_Response
Element containing the person data for the Get Person Photos response.
 
Parameter name Type/Value Cardinality Description Validations
Person_Photo  Person_Photo  [0..*]  Wrapper element for the Submit Person Photo Data element.   
top
 

Person_Photo

part of: Person_Photo_Response_Data
Wrapper element for the Submit Person Photo Data element.
 
Parameter name Type/Value Cardinality Description Validations
Person_Reference  RoleObject  [0..1]  A reference to the ID of the person through one of its active person types, such as worker, student, affiliate, external committee member, and so on. The ID consists of a type attribute, which should be set to one of either "Employee_ID", "Contingent_Worker_ID", "Student_ID", etc, and a value attribute, such as "04345".   
Person_Photo_Data  Change_Person_Photo_Data  [0..1]  Contains data for adding or updating a person's photo. 
Validation Description
Unable to find a subject for this request. Please provide one using either Person Reference or Universal ID Reference.   
You cannot initiate this action because there are other pending or completed actions for the person that conflict with this one.   
Multiple targets were found in this request. Please ensure that the Person Reference and Universal ID provided are for the same person, or remove one of them from the request.   
 
top
 

Change_Person_Photo_Data

part of: Person_Photo
Contains data for adding or updating a person's photo.
 
Parameter name Type/Value Cardinality Description Validations
Person_Reference  RoleObject  [0..1]  A unique person reference for the person whose photo is being updated.   
Universal_ID_Reference  Universal_IdentifierObject  [0..1]  A unique universal identifier reference for the person whose photo is being updated.   
Photo_Data  Person_Photo_Data  [1..1]  Person's Photo Information   
Validation Description
Unable to find a subject for this request. Please provide one using either Person Reference or Universal ID Reference.   
You cannot initiate this action because there are other pending or completed actions for the person that conflict with this one.   
Multiple targets were found in this request. Please ensure that the Person Reference and Universal ID provided are for the same person, or remove one of them from the request.   
top
 

Person_Photo_Data

part of: Change_Person_Photo_Data
Person's Photo Information
 
Parameter name Type/Value Cardinality Description Validations
Filename  string (255)   [0..1]  Name of file uploaded   
File  base64Binary  [1..1]  Data of file uploaded   
top
 

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top
 

Universal_IdentifierReferenceEnumeration

part of: Universal_IdentifierObjectID
Base Type
string
top