Service Directory > v32.1 > Talent > Get_Professional_Affiliations
 

Operation: Get_Professional_Affiliations

Returns all Professional Affiliations in the 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_Affiliations_Request

The top level response element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
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_Response_Group  [0..1]  Containing element for items that specify response characteristics.   
top
 

Response Element: Get_Professional_Affiliations_Response

The top level response element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Response_Group  Professional_Affiliation_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_Response_Data  [0..1]  Encapsulating element for the set of Professional Affiliation data returned.   
top
 

Response_Filter

part of: Get_Professional_Affiliations_Request
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_Response_Group

part of: Get_Professional_Affiliations_Request, Get_Professional_Affiliations_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_Affiliations_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_Response_Data

part of: Get_Professional_Affiliations_Response
Encapsulating element for the set of Professional Affiliation data returned.
 
Parameter name Type/Value Cardinality Description Validations
Professional_Affiliation  Professional_Affiliation  [0..*]  Encapsulating element for a Professional Affiliation.   
top
 

Professional_Affiliation

part of: Professional_Affiliation_Response_Data
Encapsulating element for a Professional Affiliation.
 
Parameter name Type/Value Cardinality Description Validations
Professional_Affiliation_Reference  Professional_AffiliationObject  [0..1]  Reference to the Professional Affiliation tied to this data.   
Professional_Affiliation_Data  Professional_Affiliation_Data  [0..*]  Data element containing all of the necessary information to create or update Professional Affiliation instance. 
Validation Description
Specify the Professional Affiliation Type.  Verifies that this is a delete operation or that this Professional Affiliation Type is specified 
Specify a name for the professional affiliation.  Verifies that a Professional Affiliation Name is specified, unless this is a delete operation 
This Professional Affiliation ID is already in use.  Verifies that this is not an edit operation if Add Only is set to true. 
This professional affiliation name is already in use.  Ensures that a Professional Affiliation with the given name doesn't already exist. 
You can't delete a Professional Affiliation that's already in use.   
 
top
 

Professional_AffiliationObject

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

Professional_AffiliationObjectID

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

part of: Professional_Affiliation
Data element containing all of the necessary information to create or update Professional Affiliation instance.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  An editable unique ID for the Professional Affiliation.   
Professional_Affiliation_Type_Reference  Professional_Affiliation_Type__All_Object  [0..1]  The type of the Professional Affiliation.   
Name  string  [0..1]  The name of this specific Affiliation.   
Inactive  boolean  [0..1]  Whether or not this Professional Affiliation is currently Active   
In_Use  boolean  [0..1]  Whether or not this Professional Affiliation is currently being used.   
Validation Description
Specify the Professional Affiliation Type.  Verifies that this is a delete operation or that this Professional Affiliation Type is specified 
Specify a name for the professional affiliation.  Verifies that a Professional Affiliation Name is specified, unless this is a delete operation 
This Professional Affiliation ID is already in use.  Verifies that this is not an edit operation if Add Only is set to true. 
This professional affiliation name is already in use.  Ensures that a Professional Affiliation with the given name doesn't already exist. 
You can't delete a Professional Affiliation that's already in use.   
top
 

Professional_Affiliation_Type__All_Object

part of: Professional_Affiliation_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_AffiliationReferenceEnumeration

part of: Professional_AffiliationObjectID
Base Type
string
top
 

Professional_Affiliation_Type__All_ReferenceEnumeration

part of: Professional_Affiliation_Type__All_ObjectID
Base Type
string
top