Service Directory > v32.1 > Human_Resources > Get_Appointment_Specialties
 

Operation: Get_Appointment_Specialties

This operation retrieves Appointment Specialties.


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

Get Appointment Specialties Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Appointment_Specialty_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of an Appointment Specialty and its associated data   
Request_Criteria [Choice]   Appointment_Specialty_Request_Criteria  [0..1]  Appointment Specialty Request Criteria   
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  Appointment_Specialty_Response_Group  [0..1]  Appointment Specialty Response Group   
top
 

Response Element: Get_Appointment_Specialties_Response

Get Appointment Specialties Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Appointment_Specialty_Request_References  [0..1]  Get Appointment Specialties Request   
Request_Criteria  Appointment_Specialty_Request_Criteria  [0..1]  Appointment Specialty Request Criteria   
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  Appointment_Specialty_Response_Group  [0..1]  Appointment Specialty Response Group   
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  Appointment_Specialty_Response_Data  [0..1]  Appointment Specialty Response Data   
top
 

Appointment_Specialty_Request_References

part of: Get_Appointment_Specialties_Request, Get_Appointment_Specialties_Response
Get Appointment Specialties Request
 
Parameter name Type/Value Cardinality Description Validations
Appointment_Specialty_Reference  Appointment_SpecialtyObject  [1..*]  Utilize the Request References element to retrieve a specific instance(s) of an Appointment Specialty and its associated data.   
top
 

Appointment_SpecialtyObject

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

Appointment_SpecialtyObjectID

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

Appointment_Specialty_Request_Criteria

part of: Get_Appointment_Specialties_Request, Get_Appointment_Specialties_Response
Appointment Specialty Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Appointment_Specialties_Request, Get_Appointment_Specialties_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
 

Appointment_Specialty_Response_Group

part of: Get_Appointment_Specialties_Request, Get_Appointment_Specialties_Response
Appointment Specialty Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

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

Appointment_Specialty_Response_Data

part of: Get_Appointment_Specialties_Response
Appointment Specialty Response Data
 
Parameter name Type/Value Cardinality Description Validations
Appointment_Specialty  Appointment_Specialty  [0..*]  Appointment Specialty   
top
 

Appointment_Specialty

part of: Appointment_Specialty_Response_Data
Appointment Specialty
 
Parameter name Type/Value Cardinality Description Validations
Appointment_Specialty_Reference  Appointment_SpecialtyObject  [0..1]  Appointment Specialty Reference   
Appointment_Specialty_Data  Appointment_Specialty_Data  [0..*]  Data for Appointment Specialty   
top
 

Appointment_Specialty_Data

part of: Appointment_Specialty
Data for Appointment Specialty
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique Identifier for the appointment specialty. If not entered, one will be generated.   
Specialty_Reference  SpecialtyObject  [1..1]  Reference to Specialty 
Validation Description
The combination of Academic Unit/Hierarchy and Specialty supplied already exists.   
 
Academic_Unit_or_Academic_Unit_Hierarchy_Reference  Academic_Appointment_SetObject  [0..1]  Academic Unit or Academic Unit Hierarchy Reference 
Validation Description
You can't delete an Appointment Specialty that is assigned to an appointment.   
You must enter an Academic Unit or Academic Unit Hierarchy to add a specialty.   
 
Inactive  boolean  [0..1]  A boolean flag to disable this appointment specialty from being assigned to any appointment   
top
 

SpecialtyObject

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

SpecialtyObjectID

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

Academic_Appointment_SetObject

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

Academic_Appointment_SetObjectID

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

Appointment_SpecialtyReferenceEnumeration

part of: Appointment_SpecialtyObjectID
Base Type
string
top
 

SpecialtyReferenceEnumeration

part of: SpecialtyObjectID
Base Type
string
top
 

Academic_Appointment_SetReferenceEnumeration

part of: Academic_Appointment_SetObjectID
Base Type
string
top