Service Directory > v31.2 > Talent > Get_Professional_Affiliation_Types
 

Operation: Get_Professional_Affiliation_Types

Get all tenanted Professional Affiliation types on this tenant.


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

Top-level element for this operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Professional_Affiliation_Type_Request_References  [0..1]  Encapsulating element for one or more references that refer to specific instances of Professional Affiliation Type.   
Request_Criteria [Choice]   Professional_Affiliation_Type_Request_Criteria  [0..1]  Currently not in use.   
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. 
 
Response_Group  Professional_Affiliation_Type_Response_Group  [0..1]  Containing element for items that specify response characteristics.   
top
 

Response Element: Get_Professional_Affiliation_Types_Response

The top level response element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Professional_Affiliation_Type_Request_References  [0..1]  Encapsulating element for one or more references to Professional Affiliations.   
Request_Criteria  Professional_Affiliation_Type_Request_Criteria  [0..1]  Currently not in use.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Professional_Affiliation_Type_Response_Group  [0..1]  Containing element for items that specify response characteristics.   
Response_Results  Response_Results  [0..1]  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  Professional_Affiliation_Type_Response_Data  [0..1]  Encapsulating element for Professional Affiliation Types.   
top
 

Professional_Affiliation_Type_Request_References

part of: Get_Professional_Affiliation_Types_Request, Get_Professional_Affiliation_Types_Response
Encapsulating element for references that refer to specific instances of of Professional Affiliation Relationship Type.
 
Parameter name Type/Value Cardinality Description Validations
Professional_Affiliation_Type_Reference  Professional_Affiliation_TypeObject  [1..*]  The set containing the Professional Affiliation type reference data.   
top
 

Professional_Affiliation_TypeObject

part of: Professional_Affiliation_Type_Request_References, Professional_Affiliation_Type
 
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_Request_Criteria

part of: Get_Professional_Affiliation_Types_Request, Get_Professional_Affiliation_Types_Response
Currently not in use.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Professional_Affiliation_Types_Request, Get_Professional_Affiliation_Types_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
 

Professional_Affiliation_Type_Response_Group

part of: Get_Professional_Affiliation_Types_Request, Get_Professional_Affiliation_Types_Response
Containing element for items that specify response characteristics.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Set this to 1 in order to include Reference ID's in the response.   
top
 

Response_Results

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

Professional_Affiliation_Type_Response_Data

part of: Get_Professional_Affiliation_Types_Response
Encapsulating element for Professional Affiliation Types.
 
Parameter name Type/Value Cardinality Description Validations
Professional_Affiliation_Type  Professional_Affiliation_Type  [0..*]  Data element containing Professional Affiliation response information.   
top
 

Professional_Affiliation_Type

part of: Professional_Affiliation_Type_Response_Data
Data element containing Professional Affiliation response information.
 
Parameter name Type/Value Cardinality Description Validations
Professional_Affiliation_Type_Reference  Professional_Affiliation_TypeObject  [0..1]  Reference to the Professional Affiliation Type ID.   
Professional_Affiliation_Type_Data  Professional_Affiliation_Type_Data  [0..*]  The data element containing all information necessary to create or edit the Professional Affiliation Relationship Type. 
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_Type_Data

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