Service Directory > v31.2 > Revenue_Management > Get_Contact_Types
 

Operation: Get_Contact_Types

Retrieves Contact Types for the specified request references or criteria. If neither are specified, all Contact Types are returned.


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

Element containing request references, criteria, filter and response group for getting Contact Type data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Contact_Type_Request_References  [0..1]  Element containing references to Contact Types.   
Request_Criteria [Choice]   Contact_Type_Request_Criteria  [0..1]  Element containing request criteria for finding Contact Types.   
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. 
 
top
 

Response Element: Get_Contact_Types_Response

Element containing Contact Type response elements.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Contact_Type_Request_References  [0..1]  Element containing references to Contact Types.   
Request_Criteria  Contact_Type_Request_Criteria  [0..1]  Element containing request criteria for finding Contact Types.   
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_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  Contact_Type_Response_Data  [0..1]  Element containing Contact Type instances and data.   
top
 

Contact_Type_Request_References

part of: Get_Contact_Types_Request, Get_Contact_Types_Response
Element containing references to Contact Types.
 
Parameter name Type/Value Cardinality Description Validations
Contact_Type_Reference  Business_Entity_Contact_Type_TenantedObject  [1..*]  References to Contact Types.   
top
 

Business_Entity_Contact_Type_TenantedObject

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

Business_Entity_Contact_Type_TenantedObjectID

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

Contact_Type_Request_Criteria

part of: Get_Contact_Types_Request, Get_Contact_Types_Response
Element containing request criteria for finding Contact Types.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Contact_Types_Request, Get_Contact_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
 

Response_Results

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

Contact_Type_Response_Data

part of: Get_Contact_Types_Response
Element containing Contact Type instances and data.
 
Parameter name Type/Value Cardinality Description Validations
Contact_Type  Contact_Type  [0..*]  Element containing a Contact Type Reference and all data for the single Contact Type.   
top
 

Contact_Type

part of: Contact_Type_Response_Data
Element containing a Contact Type Reference and all data for the single Contact Type.
 
Parameter name Type/Value Cardinality Description Validations
Contact_Type_Reference  Business_Entity_Contact_Type_TenantedObject  [0..1]  Reference to the Contact Type for which data is returned.   
Contact_Type_Data  Contact_Type_Data  [0..*]  Element containing data for a single Contact Type. 
Validation Description
Enter a Contact Type Name that isn't already in use.  Enter a Contact Type Name that isn't already in use. 
 
top
 

Contact_Type_Data

part of: Contact_Type
Element containing data for a single Contact Type.
 
Parameter name Type/Value Cardinality Description Validations
Contact_Type_ID  string  [0..1]  The reference ID of this Contact Type.   
Name  string  [1..1]  Name of this Contact Type.   
Business_Entity_Contact_Type_Reference  Business_Entity_Contact_TypeObject  [1..*]  Reference to the Business Entity Contact Type for this Contact Type.   
Inactive  boolean  [0..1]  The flag that determines whether this Contact Type is active or inactive.   
Validation Description
Enter a Contact Type Name that isn't already in use.  Enter a Contact Type Name that isn't already in use. 
top
 

Business_Entity_Contact_TypeObject

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

Business_Entity_Contact_TypeObjectID

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

Business_Entity_Contact_Type_TenantedReferenceEnumeration

part of: Business_Entity_Contact_Type_TenantedObjectID
Base Type
string
top
 

Business_Entity_Contact_TypeReferenceEnumeration

part of: Business_Entity_Contact_TypeObjectID
Base Type
string
top