Service Directory > v31.2 > Financial_Management > Put_Gift_Hierarchy
 

Operation: Put_Gift_Hierarchy

Adds or updates Gift Hierarchy. To add or update a complete Gift definition, use the Submit Gift web service.


@ - 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: Put_Gift_Hierarchy_Request

Root element that contains data to update and create Gift Hierarchy.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update. If an existing instance is found and this flag is set there will be an error.   
Gift_Hierarchy_Reference  Gift_HierarchyObject  [0..1]  Gift Hierarchy instance   
Gift_Hierarchy_Data  Gift_Hierarchy_Data  [0..1]  Wrapper Element that includes Gift Hierarchy and Data 
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.   
 
Validation Description
Gift Hierarchy ID already exists.   
top
 

Response Element: Put_Gift_Hierarchy_Response

Root element for the Request on the Put operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Gift_Hierarchy_Reference  Gift_HierarchyObject  [0..1]  Gift Hierarchy Instance created/update   
top
 

Gift_HierarchyObject

part of: Gift_Hierarchy_Data, Put_Gift_Hierarchy_Request, Put_Gift_Hierarchy_Response
 
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
 

Gift_Hierarchy_Data

part of: Put_Gift_Hierarchy_Request
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_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