Service Directory > v25.1 > Talent > Manage_Memberships
 

Operation: Manage_Memberships

This operation allows adding new professional affiliations and editing existing professional affiliations for a role.


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

Request element to manage professional affiliations for a role.
 
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.   
Manage_Memberships_Data  Manage_Professional_Affiliation_Data_for_Role  [1..1]  Wrapper element for Professional Affiliation Data.   
top
 

Response Element: Manage_Memberships_Response

Response element for Manage Professional Affiliations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Membership_Event_Reference  Unique_IdentifierObject  [0..1]  Reference to an instance of Worker Membership Event   
Membership_Reference  Professional_Affiliation_SkillObject  [0..*]  Reference to an instance of membership   
top
 

Business_Process_Parameters

part of: Manage_Memberships_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.
 
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
 
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
 

Manage_Professional_Affiliation_Data_for_Role

part of: Manage_Memberships_Request
Wrapper element for Professional Affiliation Data.
 
Parameter name Type/Value Cardinality Description Validations
Role_Reference  RoleObject  [0..1]  Role Reference 
Validation Description
Element Content 'Role_Reference' is required, on internal element 'Manage Professional Affiliation Data for Role'   
 
Source_Reference  Person_Skill_Source_CategoryObject  [0..1]  Reference to the source of the skill.   
Membership  Professional_Affiliation_Skill  [0..*]  Wrapper element for the Organization Professional Affiliation information.   
top
 

RoleObject

part of: Manage_Professional_Affiliation_Data_for_Role
 
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, External_Committee_Member_ID, Former_Worker_ID, Instructor_ID, Organization_Reference_ID, Recruiting_Agency_User_ID, RecruitingUserName, Region_Reference_ID, Service_Center_Representative_ID, Student_ID, Student_Proxy_ID, Student_Recruiter_ID, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal  [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
 

Person_Skill_Source_CategoryObject

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

Person_Skill_Source_CategoryObjectID

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

Professional_Affiliation_Skill

part of: Manage_Professional_Affiliation_Data_for_Role
Wrapper element for the Organization Professional Affiliation information.
 
Parameter name Type/Value Cardinality Description Validations
Organization_Membership_Reference  Professional_Affiliation_SkillObject  [0..1]  Reference to the membership profile.   
Organization_Membership_Data  Professional_Affiliation_Organization_Data  [0..*]  Wrapper element for the Organization Professional Affiliation information. 
Validation Description
There is an in progress event for this worker for the membership: [membership]. Only one in progress event is allowed.  Only one change can be in progress (the event in progress and not complete or canceled) for a membership for a particular worker. 
End Date must be greater than Start Date   
Specify either the Professional Affiliation Relationship Type Reference or the Affiliation.  XORs Relationship Type Reference and Affiliation because exactly one of the two must be specified. 
Specify either the Professional Affiliation Reference or the Professional Affiliation.  XORs Affiliation Reference and Membership Org because exactly one of the two must be specified. 
Remove the Professional Affiliation Type for this Professional Affiliation Reference.  Not XORs Membership Org text field and Professional Affiliation Type Reference. Ensures that If text is specified, an ad hoc Professional Affiliation is being specified. 
You can't load inactive professional affiliations.   
You can't select Company or School as the Professional Affiliation Type for ad hoc professional affiliations.   
 
top
 

Professional_Affiliation_SkillObject

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

Professional_Affiliation_SkillObjectID

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

Professional_Affiliation_Organization_Data

part of: Professional_Affiliation_Skill
Wrapper element for the Organization Professional Affiliation information.
 
Parameter name Type/Value Cardinality Description Validations
Membership_ID  string  [0..1]  Membership ID. If no value is provided, a new membership will be created. If a value is passed in an a corresponding membership is not found, a new membership will be created with the provided id.   
Remove_Membership  boolean  [0..1]  Used for inbound operations to indicate that the membership should be removed for the person. Will always return false for outbound operations. 
Validation Description
Remove Membership is true without an Membership or valid Membership ID. An Membership or valid Membership ID must be specified in order to remove the Membership.   
 
Professional_Affiliation_Reference  Professional_Affiliation_ReferenceObject  [0..1]  The Professional Affiliation that this achievement is representing a relationship with.   
Membership  string  [0..1]  The name of the organization the person is member of. Required unless the membership is being removed. 
Validation Description
Membership must be specified unless the membership is being removed.   
 
Professional_Affiliation_Type_Reference  Professional_Affiliation_Type__All_Object  [0..1]  The type of Professional Affiliation.   
Affiliation  string  [0..1]  Any organization that the membership is affiliated to.   
Professional_Affiliation_Relationship_Type_Reference  Professional_Affiliation_Relationship_TypeObject  [0..1]  The Relationship that this Person has to this Organization.   
Begin_Date  date  [0..1]  The date when the membership was started.   
End_Date  date  [0..1]  The date when the membership was ended.   
Validation Description
There is an in progress event for this worker for the membership: [membership]. Only one in progress event is allowed.  Only one change can be in progress (the event in progress and not complete or canceled) for a membership for a particular worker. 
End Date must be greater than Start Date   
Specify either the Professional Affiliation Relationship Type Reference or the Affiliation.  XORs Relationship Type Reference and Affiliation because exactly one of the two must be specified. 
Specify either the Professional Affiliation Reference or the Professional Affiliation.  XORs Affiliation Reference and Membership Org because exactly one of the two must be specified. 
Remove the Professional Affiliation Type for this Professional Affiliation Reference.  Not XORs Membership Org text field and Professional Affiliation Type Reference. Ensures that If text is specified, an ad hoc Professional Affiliation is being specified. 
You can't load inactive professional affiliations.   
You can't select Company or School as the Professional Affiliation Type for ad hoc professional affiliations.   
top
 

Professional_Affiliation_ReferenceObject

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

Professional_Affiliation_ReferenceObjectID

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

Professional_Affiliation_Type__All_Object

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

Professional_Affiliation_Type__All_ObjectID

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

Professional_Affiliation_Relationship_TypeObject

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

Professional_Affiliation_Relationship_TypeObjectID

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

Unique_IdentifierObject

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

Person_Skill_Source_CategoryReferenceEnumeration

part of: Person_Skill_Source_CategoryObjectID
Base Type
string
top
 

Professional_Affiliation_SkillReferenceEnumeration

part of: Professional_Affiliation_SkillObjectID
Base Type
string
top
 

Professional_Affiliation_ReferenceReferenceEnumeration

part of: Professional_Affiliation_ReferenceObjectID
Base Type
string
top
 

Professional_Affiliation_Type__All_ReferenceEnumeration

part of: Professional_Affiliation_Type__All_ObjectID
Base Type
string
top
 

Professional_Affiliation_Relationship_TypeReferenceEnumeration

part of: Professional_Affiliation_Relationship_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top