Service Directory > v31.2 > Human_Resources > Get_Organization_Reference_IDs
 

Operation: Get_Organization_Reference_IDs

This task can be used to retrieve Organization Reference ID for an Organization.


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

Request for Get Organization Reference IDs.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Organization_Reference_ID_Request_References  [0..1]  Organization Reference ID Request References   
Request_Criteria [Choice]   Organization_Reference_ID_Request_Criteria  [0..1]  Organization Reference ID 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. 
 
top
 

Response Element: Get_Organization_Reference_IDs_Response

Response for Get Organization Reference IDs
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Organization_Reference_ID_Request_References  [0..1]  Organization Reference ID Request References   
Request_Criteria  Organization_Reference_ID_Request_Criteria  [0..1]  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_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  Organization_Reference_ID_Response_Data  [0..1]  Response Data   
top
 

Organization_Reference_ID_Request_References

part of: Get_Organization_Reference_IDs_Request, Get_Organization_Reference_IDs_Response
Organization Reference ID Request References
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference_ID_Reference  OrganizationObject  [1..*]  Holds Organizations for which IDs are to be retrieved.   
top
 

OrganizationObject

part of: Organization_Reference_ID_Request_References, Organization_Reference_ID
 
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
 

Organization_Reference_ID_Request_Criteria

part of: Get_Organization_Reference_IDs_Request, Get_Organization_Reference_IDs_Response
Organization Reference ID Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Organization_Reference_IDs_Request, Get_Organization_Reference_IDs_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_Organization_Reference_IDs_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
 

Organization_Reference_ID_Response_Data

part of: Get_Organization_Reference_IDs_Response
Organization Reference ID Response Data
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference_ID  Organization_Reference_ID  [0..*]  Holds Organization Reference ID information   
top
 

Organization_Reference_ID

part of: Organization_Reference_ID_Response_Data
Organization Reference ID Response Data
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [0..1]  The Reference ID information is for this Organization.   
Organization_ID_Data  Organization_Reference_ID_Reference_Data  [0..*]  Holds data for Organization Reference ID   
top
 

Organization_Reference_ID_Reference_Data

part of: Organization_Reference_ID
Holds data for Organization Reference ID
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference_ID  string  [0..1]  Organization Reference ID 
Validation Description
The proposed reference id is already in use on a different organization. Duplicate reference ids are not allowed because the reference id must be unique for integrations.   
 
Organization_Name  string  [0..1]  Organization Name. This field is read-only and should not be post back in Put Organization ID Request.   
Include_Organization_ID_in_Name  boolean  [0..1]  This option is only allowed for Supervisory Organization at the moment. When set to true, Supervisory Organizations will have Organization Reference ID suffixed to their names. A new effective-dated organization name is automatically created if value for this field is different as of current moment. 
Validation Description
'Include Organization ID in Name' can only be set to true for supervisory organizations.   
 
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top