Service Directory > v32.1 > Human_Resources > Change_Licenses
 

Operation: Change_Licenses

This web service allows the updating of Licenses for a worker.


@ - 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: Change_Licenses_Request

This web service allows the updating of license identifiers for a worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Change_Licenses_Data  Change_Licenses_Business_Process_Data  [1..1]  Wrapper element for the License Identifier data. 
Validation Description
You cannot initiate this action because there is another pending actions for the worker's licenses.   
Validation Description
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.   
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.   
 
top
 

Response Element: Change_Licenses_Response

Response for the change licenses web service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
License_Identifier_Event_Reference  Unique_IdentifierObject  [0..1]  Event ID of the License Identifier Event.   
top
 

Business_Process_Parameters

part of: Change_Licenses_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data, License_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  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
 

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Change_Licenses_Business_Process_Data

part of: Change_Licenses_Request
Wrapper element for the License 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 license identifier(s) will be applied to.   
License_Identification_Data  License_Identification_Data  [1..1]  Wrapper for License Identification Data. Includes License Identifiers.   
Validation Description
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.   
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.   
top
 

RoleObject

part of: Change_Licenses_Business_Process_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  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_Assessor_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_Licenses_Business_Process_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
 

License_Identification_Data

part of: Change_Licenses_Business_Process_Data
Wrapper for License Identification Data. Includes License 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.   
License_ID  License_ID  [0..*]  Encapsulating element for all License Identifier data. 
Validation Description
The License Identifier Shared Reference should be used with the Change License web service.   
The License Identifier Shared Reference should be used with the Change License web service.   
If the ID is marked for deletion, a License Identifier Shared Reference ID should be included.   
License Identifier with reference [lir] is marked for deletion. License ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The License ID referenced by [license identifier reference] does not belong to [person].   
License Identifier [identifier] with workday id [workday id] is not a valid license identifier for the person.   
 
top
 

License_ID

part of: License_Identification_Data
Encapsulating element for all License 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   
License_ID_Reference  License_IdentifierObject  [0..1]  Reference ID for the License Identifier.   
License_ID_Data  License_ID_Data  [0..1]  Wrapper element for the License Identifier data. 
Validation Description
Only one of Country Reference, Country Region Reference, or Authority Reference is allowed.  In order to specify an issuing body for the license, only one of Country Reference, Country Region Reference, or Authority Reference is allowed. 
 
License_ID_Shared_Reference  License_Identifier_ReferenceObject  [0..1]  Shared Reference ID for License Identifiers.   
Validation Description
The License Identifier Shared Reference should be used with the Change License web service.   
The License Identifier Shared Reference should be used with the Change License web service.   
If the ID is marked for deletion, a License Identifier Shared Reference ID should be included.   
License Identifier with reference [lir] is marked for deletion. License ID Data should not be included.   
If the ID is not marked for deletion, ID data should be included.   
The License ID referenced by [license identifier reference] does not belong to [person].   
License Identifier [identifier] with workday id [workday id] is not a valid license identifier for the person.   
top
 

License_IdentifierObject

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

License_IdentifierObjectID

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

License_ID_Data

part of: License_ID
Wrapper for License Identifier Data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  License Identifier. 
Validation Description
Identifier ID is Required   
 
ID_Type_Reference  License_ID_Type__All_Object  [0..1]  License Identifier Type. 
Validation Description
License ID Type required.   
Identifier type in this request is inactive. Only active statuses are allowed.   
 
Country_Reference  CountryObject  [0..1]  Country issuing the License Identifier. No more than one Country Reference, Country Region Reference, or Authority Reference can be specified.   
Country_Region_Reference  Country_RegionObject  [0..1]  Country Region issuing the License Identifier. No more than one Country Reference, Country Region Reference, or Authority Reference can be specified.   
Country_Region_Descriptor  string  [0..1]  Country Region issuing the License Identifier. No more than one Country Reference, Country Region Reference, or Authority Reference can be specified.   
Authority_Reference  AuthorityObject  [0..1]  Authority issuing the License Identifier. No more than one Country Reference, Country Region Reference, or Authority Reference can be specified.   
License_Class  string  [0..1]  License Class.   
Issued_Date  date  [0..1]  Date the License 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 License Identifier.   
Verification_Date  date  [0..1]  Verification Date of the License Identifier.   
Verified_By_Reference  WorkerObject  [0..1]  Worker who verified the ID. 
Validation Description
Select a different worker in the Verified By field. The worker you entered was terminated before the Verification Date: [date].   
 
Validation Description
Only one of Country Reference, Country Region Reference, or Authority Reference is allowed.  In order to specify an issuing body for the license, only one of Country Reference, Country Region Reference, or Authority Reference is allowed. 
top
 

License_ID_Type__All_Object

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

License_ID_Type__All_ObjectID

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

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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
 

Country_RegionObject

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

Country_RegionObjectID

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

AuthorityObject

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

AuthorityObjectID

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

License_Identifier_ReferenceObject

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

License_Identifier_ReferenceObjectID

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

Unique_IdentifierObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

RoleReferenceEnumeration

part of: RoleObjectID
Base Type
string
top
 

Universal_IdentifierReferenceEnumeration

part of: Universal_IdentifierObjectID
Base Type
string
top
 

License_IdentifierReferenceEnumeration

part of: License_IdentifierObjectID
Base Type
string
top
 

License_ID_Type__All_ReferenceEnumeration

part of: License_ID_Type__All_ObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

AuthorityReferenceEnumeration

part of: AuthorityObjectID
Base Type
string
top
 

License_Identifier_ReferenceReferenceEnumeration

part of: License_Identifier_ReferenceObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top