Service Directory > v31.2 > Staffing > Get_Change_Other_IDs
 

Operation: Get_Change_Other_IDs

This public web service request gets custom IDs for a worker. The response can be used as input to the web service request Change Other IDs.


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

Request element used to get other IDs for a worker. The response is formatted to be usable as input to the Change Other IDs web service request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_Change_Other_IDs_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance or instances of Worker and its associated IDs. 
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. 
 
Request_Criteria_Data  Change_Other_ID_Request_Criteria  [0..1]  Allows retrieving Passport and Visa IDs based on request criteria. 
Validation Description
Invalid request filter provided. Include at least one person type in the request  Invalid request filter provided. Include at least one person type in the request 
 
top
 

Response Element: Get_Change_Other_IDs_Response

Response element containing a worker's other IDs.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Get_Change_Other_IDs_Request_References  [0..*]  Utilize the Request References element to retrieve a specific instance or instances of Worker and its associated IDs. 
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..*]  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..*]  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  Change_Other_IDs_Response_Data  [0..*]  element containing the worker data for the Get Change Other IDs response.   
top
 

Get_Change_Other_IDs_Request_References

part of: Get_Change_Other_IDs_Request, Get_Change_Other_IDs_Response
Utilize the Request References element to retrieve a specific instance or instances of Worker and its associated IDs.
 
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: Change_Other_IDs_Business_Process_Data, Get_Change_Other_IDs_Request_References, Change_Other_IDs_Response_Wrapper
 
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: Change_Other_IDs_Business_Process_Data, Get_Change_Other_IDs_Request_References
 
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_Change_Other_IDs_Request, Get_Change_Other_IDs_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
 

Change_Other_ID_Request_Criteria

part of: Get_Change_Other_IDs_Request
Allows retrieving Passport and Visa IDs based on request criteria.
 
Parameter name Type/Value Cardinality Description Validations
Person_Type_Criteria_Data  Person_Type_Criteria  [0..1]  Provides selection for filtering the response   
Validation Description
Invalid request filter provided. Include at least one person type in the request  Invalid request filter provided. Include at least one person type in the request 
top
 

Person_Type_Criteria

part of: Change_Other_ID_Request_Criteria
Provides selection for filtering the response
 
Parameter name Type/Value Cardinality Description Validations
Include_Academic_Affiliates  boolean  [0..1]  Include Academic Affiliates   
Include_External_Committee_Members  boolean  [0..1]  Include External Committee Members   
Include_External_Student_Records  boolean  [0..1]  Include External Student Records   
Include_Student_Prospect_Records  boolean  [0..1]  Include Student Prospect Records   
Include_Student_Records  boolean  [0..1]  Include Student Records   
Include_Workers  boolean  [0..1]  Include Workers   
top
 

Response_Results

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

Change_Other_IDs_Response_Data

part of: Get_Change_Other_IDs_Response
element containing the worker data for the Get Change Other IDs response.
 
Parameter name Type/Value Cardinality Description Validations
Change_Other_IDs  Change_Other_IDs_Response_Wrapper  [0..*]  Wrapper element for the Change Other IDs Business Process Data element. This is the element that contains the data to load.   
top
 

Change_Other_IDs_Response_Wrapper

part of: Change_Other_IDs_Response_Data
Wrapper element for the Change Other IDs Business Process Data element. This is the element that contains the data to load.
 
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".   
Change_Other_IDs_Data  Change_Other_IDs_Business_Process_Data  [0..*]  Reference to the Worker that the government identifier(s) will be applied to. 
Validation Description
Unable to find a subject for this request. Please provide one using either Person Reference or Universal ID Reference.   
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.   
You cannot initiate this action because there are other pending or completed actions for the person that conflict with this one.   
 
top
 

Change_Other_IDs_Business_Process_Data

part of: Change_Other_IDs_Response_Wrapper
Wrapper element for the Other Identifier Data.
 
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".   
Universal_ID_Reference  Universal_IdentifierObject  [0..1]  Universal ID Reference for the Person that the Passport and Visa will be applied to.   
Custom_Identification_Data  Custom_Identification_Data  [1..1]  Wrapper for Custom Identification Data. Includes Custom Identifiers.   
Validation Description
Unable to find a subject for this request. Please provide one using either Person Reference or Universal ID Reference.   
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.   
You cannot initiate this action because there are other pending or completed actions for the person that conflict with this one.   
top
 

Custom_Identification_Data

part of: Change_Other_IDs_Business_Process_Data
Wrapper for Custom Identification Data. Includes Custom Identifiers.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  If Replace All is set to True, a full sync is performed after you submit the web service. Set to False if you want to preserve the existing data and only add, edit, or remove specific reference ids. Note: If you leave this boolean value blank it defaults to True to preserve the existing Replace All functionality in older versions of this web service for web service users depending on the default behavior.   
Custom_ID  Custom_ID  [0..*]  Wrapper element for all Custom Identifier Data. 
Validation Description
The Custom Identifier Shared Reference should be used with the Change Other IDs web service.   
The Custom Identifier Shared Reference should be used with the Change Other IDs web service.   
Custom Identifier with reference [cir] is marked for deletion. Custom ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The Custom ID referenced by [custom identifier reference] does not belong to [person].   
Custom Identifier [identifier] with workday id [workday id] is not a valid custom identifier for the person.   
 
top
 

Custom_ID

part of: Custom_Identification_Data
Encapsulating element for all Custom Identifier data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If Delete is set to True and Replace All has been set to False, the ID will be deleted when the web service is submitted. Note: The Replace All flag defaults to False if not specified in the web service   
Custom_ID_Reference  Unique_IdentifierObject  [0..1]  Reference ID for Custom Identifier.   
Custom_ID_Data  Custom_ID_Data  [0..1]  Wrapper element for Custom Identifier data.   
Custom_ID_Shared_Reference  Custom_Identifier_ReferenceObject  [0..1]  Shared Reference ID for Custom Identifiers.   
Validation Description
The Custom Identifier Shared Reference should be used with the Change Other IDs web service.   
The Custom Identifier Shared Reference should be used with the Change Other IDs web service.   
Custom Identifier with reference [cir] is marked for deletion. Custom ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The Custom ID referenced by [custom identifier reference] does not belong to [person].   
Custom Identifier [identifier] with workday id [workday id] is not a valid custom identifier for the person.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Custom_ID_Data

part of: Custom_ID
Wrapper for Custom Identifier Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Custom Identifier. 
Validation Description
Identifier ID required. Custom ID Type specified does not have a sequence generator.   
 
ID_Type_Reference  Custom_ID_TypeObject  [0..1]  Custom Identifier Type. 
Validation Description
Custom ID Type is required.   
Identifier type in this request is inactive. Only active statuses are allowed.   
 
Issued_Date  date  [0..1]  Date the Custom Identifier was issued. 
Validation Description
Enter an Issue date that is on or before the expiration date: [exp date].   
 
Expiration_Date  date  [0..1]  Expiration Date of the Custom Identifier.   
Organization_ID_Reference  OrganizationObject  [0..1]  Organization issuing the Custom Identifier.   
Custom_Description  string  [0..1]  Description of the Custom Identifier.   
top
 

Custom_ID_TypeObject

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

Custom_ID_TypeObjectID

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

OrganizationObject

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

OrganizationObjectID

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

Custom_Identifier_ReferenceObject

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

Custom_Identifier_ReferenceObjectID

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

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top
 

Universal_IdentifierReferenceEnumeration

part of: Universal_IdentifierObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Custom_ID_TypeReferenceEnumeration

part of: Custom_ID_TypeObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Custom_Identifier_ReferenceReferenceEnumeration

part of: Custom_Identifier_ReferenceObjectID
Base Type
string
top