Service Directory > v31.2 > Financial_Management > Get_Gift_Hierarchies
 

Operation: Get_Gift_Hierarchies

Task to get all or some Gift Hierarchies


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

Root element for the Request to Get Gift Hierarchies.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Gift_Hierarchy_Request_References  [0..1]  Element containing request references for a Gift Hierarchy.   
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  Gift_Hierarchy_Response_Group  [0..1]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then all groups will be returned. If the Response Group element is returned, you can select which sections of data to include in the response.   
top
 

Response Element: Get_Gift_Hierarchies_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Gift_Hierarchy_Request_References  [0..1]  Element containing request references for a Gift Hierarchy.   
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  Gift_Hierarchy_Response_Group  [0..1]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then all groups will be returned. If the Response Group element is returned, you can select which sections of data to include in the response.   
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  Gift_Hierarchy_Response_Data  [0..1]  Gift Hierarchies Response Data.   
top
 

Gift_Hierarchy_Request_References

part of: Get_Gift_Hierarchies_Request, Get_Gift_Hierarchies_Response
Element containing request references for a Gift Hierarchy.
 
Parameter name Type/Value Cardinality Description Validations
Gift_Hierarchy_Reference  Gift_HierarchyObject  [1..*]  References for the Gift Hierarchies to get.   
top
 

Gift_HierarchyObject

part of: Gift_Hierarchy_Request_References, Gift_Hierarchy, Gift_Hierarchy_Data, Gift_Hierarchy_Children
 
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  Gift_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Gift_HierarchyObjectID

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

Response_Filter

part of: Get_Gift_Hierarchies_Request, Get_Gift_Hierarchies_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
 

Gift_Hierarchy_Response_Group

part of: Get_Gift_Hierarchies_Request, Get_Gift_Hierarchies_Response
The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then all groups will be returned. If the Response Group element is returned, you can select which sections of data to include in the response.
 
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_Gift_Hierarchies_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
 

Gift_Hierarchy_Response_Data

part of: Get_Gift_Hierarchies_Response
Gift Hierarchies Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Gift_Hierarchy  Gift_Hierarchy  [0..*]  Root element that has all of the data about the gift and it's children.   
top
 

Gift_Hierarchy

part of: Gift_Hierarchy_Response_Data
Root element that has all of the data about the gift and it's children.
 
Parameter name Type/Value Cardinality Description Validations
Gift_Hierarchy_Reference  Gift_HierarchyObject  [0..1]  Gift Hierarchy instance   
Gift_Hierarchy_Data  Gift_Hierarchy_Data  [0..1]  Root element that contains data to update and create Gift Hierarchy. 
Validation Description
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Organization Subtype for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
 
Gift_Hierarchy_Children  Gift_Hierarchy_Children  [0..1]  Element that contains information of children   
top
 

Gift_Hierarchy_Data

part of: Gift_Hierarchy
Wrapper Element that includes Gift Hierarchy and Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Gift Hierarchy Reference ID   
Name  string  [1..1]  Gift Hierarchy Name 
Validation Description
Gift Hierarchy Name already exists. Provide a unique Gift Hierarchy Name.   
 
Include_Gift_Hierarchy_ID_in_Name  boolean  [0..1]  Boolean value indicating if the Gift Hierarchy ID will be included in the display of the Gift Hierarchy Name.   
Inactive  boolean  [0..1]  Whether or not a gift is inactive.   
Organization_Subtype_Reference  Organization_SubtypeObject  [0..1]  Reference to an existing Organization Subtype valid for Gift Hierarchies. 
Validation Description
Organization Subtype is not valid for Organization Type  Organization Subtype needs to be valid for Organization Type. 
 
Superior_Gift_Hierarchy_Reference  Gift_HierarchyObject  [0..1]  Gift Hierarchy contained within Gift Hierarchy. 
Validation Description
Cannot include an inactive Gift Hierarchy in another Gift Hierarchy tree.   
The superior Gift Hierarchy must be active, may not contain any of the same active Gifts, and may not be equal to or a descendant of the current Gift Hierarchy.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
 
Gift_Reference  GiftObject  [0..*]  Gifts that are contained in this level of the Gift Hierarchy. 
Validation Description
Inactive Gift Hierarchies may not contain any Gifts.   
The Gift Hierarchy may not contain Gifts that are already in the hierarchy tree.   
 
Validation Description
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Organization Subtype for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
top
 

Organization_SubtypeObject

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

Organization_SubtypeObjectID

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

GiftObject

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

GiftObjectID

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

Gift_Hierarchy_Children

part of: Gift_Hierarchy
Gift Hierarchy contained within Gift Hierarchy.
 
Parameter name Type/Value Cardinality Description Validations
Child_Gift_Hierarchy_Reference  Gift_HierarchyObject  [0..*]  Gift Hierarchy contained within Gift Hierarchy.   
top
 

Gift_HierarchyReferenceEnumeration

part of: Gift_HierarchyObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

GiftReferenceEnumeration

part of: GiftObjectID
Base Type
string
top