Service Directory > v32.1 > Human_Resources > Put_Workteam_Membership
 

Operation: Put_Workteam_Membership

Add, Change or Remove a Workteam Membership.


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

Add a new Membership to the Workteam.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Workteam_Reference  WorkteamObject  [1..1]  The workteam to which a new member should be added.   
Workteam_Membership_Data  Workteam_Membership_Data  [1..*]  Information required for the workteam membership. 
Validation Description
Membership status cannot be empty for action.   
If the delete flag is true, the effective date must be empty.   
 
top
 

Response Element: Put_Workteam_Membership_Response

Response containing workteam membership reference.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Workteam_Membership_Reference  WorkteamObject  [0..1]  Workteam membership reference.   
top
 

WorkteamObject

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

WorkteamObjectID

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

Workteam_Membership_Data

part of: Put_Workteam_Membership_Request
Information required for the workteam membership.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  When true, membership status and effective date must be empty. The specified worker must be a workteam member now or in the future. When a workteam member is deleted, it is as if they were never a member and their entire membership status history is also deleted. If you want to retain membership status history after a member departs, Workday recommends that you change the member's status to Inactive instead.   
Effective_Date  date  [0..1]  When the worker is not a member as of this effective date, they are added as a member with the specified effective date and membership status. When the worker is a member as of the specified effective date, only their membership status is updated. Use the same effective date as an existing membership status snapshot to correct the membership status. To correct the effective date of a membership status to an earlier date, specify the desired effective date and the same membership status as the next effective-dated snapshot. When the effective date is empty, the current date is used.   
Worker_Reference  WorkerObject  [1..1]  Worker ID. Can specify either the ID or WID.   
Workteam_Membership_Status_Reference  Workteam_Membership_StatusObject  [0..1]  Required unless Delete is true. Valid values are Active, Passive, or Inactive.   
Validation Description
Membership status cannot be empty for action.   
If the delete flag is true, the effective date must be empty.   
top
 

WorkerObject

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

Workteam_Membership_StatusObject

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

Workteam_Membership_StatusObjectID

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

WorkteamReferenceEnumeration

part of: WorkteamObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Workteam_Membership_StatusReferenceEnumeration

part of: Workteam_Membership_StatusObjectID
Base Type
string
top