Service Directory > v31.2 > Resource_Management > Get_Internal_Service_Providers
 

Operation: Get_Internal_Service_Providers

This Web Service operation will get Internal Service Providers for the specified criteria. The request criteria can be for a specific Internal Service Provider based on a Reference ID or can include search criteria based on the following attributes - Company, Internal Service Provider Name, Internal Service Provider ID, Inactive, and Currency. Internal Service Provider response data includes Company, Internal Service Provider Name, Internal Service Provider ID, Inactive, and Currency.


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

Element containing sub elements for Request Reference, Request Criteria, Response Filter and Response Group to retrieve Internal Service Deliveries
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Internal_Service_Provider_Request_References  [0..1]  Element that contains references to existing Internal Service Provider to be retrieved. Please note that this is mutually exclusive with the Request Criteria element.   
Request_Criteria [Choice]   Internal_Service_Provider_Request_Criteria  [0..1]  Element containing criteria used to retrieve Internal Service Providers. Please note that this is mutually exclusive with the Request References element.   
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  Internal_Service_Provider_Response_Group  [0..1]  Element containing the Internal Service Providers response group.   
top
 

Response Element: Get_Internal_Service_Providers_Response

Element containing Internal Service Provider information, including Request References and Criteria.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Internal_Service_Provider_Request_References  [0..1]  Element that contains references to Internal Service Provider to be retrieved via the Get Internal Service Provider Web Service operation.   
Request_Criteria  Internal_Service_Provider_Request_Criteria  [0..1]  Element that contains criteria used to search for Internal Service Provider. It includes Company, Internal Service Provider Name, Internal Service Provider ID, Inactive Status, and Currency.   
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  Internal_Service_Provider_Response_Group  [0..1]  Element containing the Internal Service Providers 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  Internal_Service_Provider_Response_Data  [0..1]  Topmost Response Element that represents the Reference to the Internal Service Provider along with its content.   
top
 

Internal_Service_Provider_Request_References

part of: Get_Internal_Service_Providers_Request, Get_Internal_Service_Providers_Response
Element that contains references to existing Internal Service Providers to be retrieved.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Service_Provider_Reference  Internal_Service_ProviderObject  [1..*]  References to existing Internal Service Providers to be retrieved via the Get Internal Service Provider Web Service operation   
top
 

Internal_Service_ProviderObject

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

Internal_Service_ProviderObjectID

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

Internal_Service_Provider_Request_Criteria

part of: Get_Internal_Service_Providers_Request, Get_Internal_Service_Providers_Response
Element containing criteria used to retrieve Internal Service Providers.
 
Parameter name Type/Value Cardinality Description Validations
Company_or_Company_Hierarchy_Reference  OrganizationObject  [0..*]  Reference to existing companies or company hierarchies.   
Internal_Service_Provider_Name  string  [0..1]  Internal Service Provider Name.   
Internal_Service_Provider_ID  string  [0..1]  Internal Service Provider ID.   
Inactive  boolean  [0..1]  In inactive status or not.   
Currency_Reference  CurrencyObject  [0..*]  Reference to an existing currency for an Internal Service Provider.   
top
 

OrganizationObject

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

OrganizationObjectID

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

CurrencyObject

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

CurrencyObjectID

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

Response_Filter

part of: Get_Internal_Service_Providers_Request, Get_Internal_Service_Providers_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
 

Internal_Service_Provider_Response_Group

part of: Get_Internal_Service_Providers_Request, Get_Internal_Service_Providers_Response
Element containing the Internal Service Provider response group.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Internal_Service_Provider_Response_Data

part of: Get_Internal_Service_Providers_Response
Topmost Response Element that represents the Reference to the Internal Service Provider along with its content.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Service_Provider  Internal_Service_Provider  [0..*]  Element that represents the Reference to the Internal Service Provider along with its content.   
top
 

Internal_Service_Provider

part of: Internal_Service_Provider_Response_Data
Element that represents the Reference to the Internal Service Provider along with its content.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Service_Provider_Reference  Internal_Service_ProviderObject  [0..1]  Reference to the Internal Service Provider.   
Internal_Service_Provider_Data  Internal_Service_Provider_Data  [0..*]  Element that represents the contents of the Internal Service Provider. 
Validation Description
The following Accounting Worktags are required but have not been assigned - [missing].   
The following Accounting worktags are not valid for this transaction - [list of worktag types].   
Only one worktag of each type is allowed   
Enter an Internal Service Provider Name that isn't already in use.   
Internal Catalogs cannot be specified when creating an Internal Service Provider.   
Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance.  Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance. 
 
top
 

Internal_Service_Provider_Data

part of: Internal_Service_Provider
Element that represents the contents of the Internal Service Provider.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Service_Provider_Reference_ID  string  [0..1]  Reference ID   
Internal_Service_Provider_Name  string  [1..1]  Internal Service Provider Name.   
Internal_Service_Provider_ID  string  [1..1]  Internal Service Provider ID.   
Currency_Reference  CurrencyObject  [0..1]  Currency for an Internal Service Provider.   
Inactive  boolean  [0..1]  Indicates whether the Internal Service Provider is inactive or not.   
Internal_Catalog_Reference  Abstract_Procurement_CatalogObject  [0..*]  Internal Catalogs associated with an Internal Service Provider. This is read-only and cannot be specified when creating an Internal Service Provider.   
Company_or_Company_Hierarchy_Reference  OrganizationObject  [1..*]  Companies or company hierarchies associated with an Internal Service Provider.   
Review_Date  date  [0..1]  The date on which the Internal Service Provider was last reviewed.   
Next_Review_Date  date  [0..1]  The date on which the Internal Service Provider becomes eligible for review.   
Description  string  [0..1]  The descriptive information or comments about the Internal Service Provider.   
Revenue_Category_Reference  Revenue_CategoryObject  [0..1]  Revenue category associated with an Internal Service Provider.   
Internal_Service_Provider_Worktag_Reference  Accounting_WorktagObject  [0..*]  Worktags associated with an Internal Service Provider 
Validation Description
[worktag value] is not permitted as an allowed value for worktag type: [worktag type], because it is inactive.   
 
Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
The following Accounting Worktags are required but have not been assigned - [missing].   
The following Accounting worktags are not valid for this transaction - [list of worktag types].   
Only one worktag of each type is allowed   
Enter an Internal Service Provider Name that isn't already in use.   
Internal Catalogs cannot be specified when creating an Internal Service Provider.   
Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance.  Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance. 
top
 

Abstract_Procurement_CatalogObject

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

Abstract_Procurement_CatalogObjectID

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

Revenue_CategoryObject

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

Revenue_CategoryObjectID

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

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Financials_Attachment_Data

part of: Internal_Service_Provider_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Internal_Service_ProviderReferenceEnumeration

part of: Internal_Service_ProviderObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Abstract_Procurement_CatalogReferenceEnumeration

part of: Abstract_Procurement_CatalogObjectID
Base Type
string
top
 

Revenue_CategoryReferenceEnumeration

part of: Revenue_CategoryObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top