Service Directory > v32.1 > Talent > Put_Professional_Affiliation_Type
 

Operation: Put_Professional_Affiliation_Type

Web service to add, delete, or update tenanted Professional Affiliation Types.


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

Top-level element for this operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Delete  boolean  [0..1]  This flag indicates a delete operation.   
Add_Only  boolean  [0..1]  Prevents editing existing Professional Affiliation Types.   
Professional_Affiliation_Type_Reference  Professional_Affiliation_TypeObject  [0..1]  The Professional Affiliation Type ID of the instance to be edited.   
Professional_Affiliation_Type_Data  Professional_Affiliation_Type_Data  [1..1]  The data element with the information required to create or update a Professional Affiliation Type instance. 
Validation Description
Specify the Professional Affiliation Type.  Verifies that a name is provided or this is a delete operation. 
This Professional Affiliation Type ID is already in use.  Checks to make sure that an update isn't happening if request is Add Only. 
This Professional Affiliation Type Name is already in use.  Verifies that no PAT exists with the given name already. 
You can't delete a Professional Affiliation Type that's already in use.  Verifies that instances in use are not deleted. 
 
top
 

Response Element: Put_Professional_Affiliation_Type_Response

Encapsulating element for the Professional Affiliation Type response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Professional_Affiliation_Type_Reference  Professional_Affiliation_TypeObject  [0..1]  Encapsulating element for the Professional Affiliation Type response.   
top
 

Professional_Affiliation_TypeObject

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

Professional_Affiliation_TypeObjectID

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

part of: Put_Professional_Affiliation_Type_Request
The data element containing all information necessary to create or edit the Professional Affiliation Type.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A unique ID for the Professional Affiliation Type.   
Name  string  [0..1]  The name of the Professional Affiliation Type.   
Description  string  [0..1]  A description of the Professional Affiliation Type.   
In_Use  boolean  [0..1]  Whether or not an instance in the organization is using this Professional Affiliation Type   
Inactive  boolean  [0..1]  Indicates that this Professional Affiliation Relationship Type is currently useable in the organization.   
Validation Description
Specify the Professional Affiliation Type.  Verifies that a name is provided or this is a delete operation. 
This Professional Affiliation Type ID is already in use.  Checks to make sure that an update isn't happening if request is Add Only. 
This Professional Affiliation Type Name is already in use.  Verifies that no PAT exists with the given name already. 
You can't delete a Professional Affiliation Type that's already in use.  Verifies that instances in use are not deleted. 
top
 

Professional_Affiliation_TypeReferenceEnumeration

part of: Professional_Affiliation_TypeObjectID
Base Type
string
top