Service Directory > v32.1 > Financial_Management > Get_Basic_Grants
 

Operation: Get_Basic_Grants

Retrieves Grants when they are used as worktag values only. Basic Grant data includes Grant ID, Grant Name, and Inactive status. The request criteria can be for a single transaction based on Reference ID. If no criteria is specified, the operation retrieves all transactions.


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

Contains request reference, criteria, filter and response group for getting basic grant worktags data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Basic_Grant_Request_References  [0..1]  Get Basic Grant Request References   
Request_Criteria [Choice]   Basic_Grant_Request_Criteria  [0..1]  Get Basic Grant 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  Basic_Grant_Response_Group  [0..1]  Get Basic Grant Response Group   
top
 

Response Element: Get_Basic_Grants_Response

Element containing basic grant response elements including received criteria, references, data based
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Basic_Grant_Request_References  [0..1]  Element containing reference instances for basic grants   
Request_Criteria  Basic_Grant_Request_Criteria  [0..1]  Element containing basic grant 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  Basic_Grant_Response_Group  [0..1]  Element containing grant response grouping options   
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  Basic_Grant_Response_Data  [0..1]  Wrapper Element that includes basic Grant Instance and Data   
top
 

Basic_Grant_Request_References

part of: Get_Basic_Grants_Request, Get_Basic_Grants_Response
Element containing reference instances for basic grants
 
Parameter name Type/Value Cardinality Description Validations
Basic_Grant_Reference  GrantObject  [1..*]  This is the reference ID value of the basic grant instance   
top
 

GrantObject

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

GrantObjectID

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

Basic_Grant_Request_Criteria

part of: Get_Basic_Grants_Request, Get_Basic_Grants_Response
Element containing basic grant request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Basic_Grants_Request, Get_Basic_Grants_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
 

Basic_Grant_Response_Group

part of: Get_Basic_Grants_Request, Get_Basic_Grants_Response
Element containing grant response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Basic_Grant_Response_Data

part of: Get_Basic_Grants_Response
Wrapper Element that includes basic Grant Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Basic_Grant  Basic_Grant  [0..*]  Wrapper Element that includes basic Grant Instance and Data   
top
 

Basic_Grant

part of: Basic_Grant_Response_Data
Wrapper Element that includes basic Grant Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Basic_Grant_Reference  GrantObject  [0..1]  This is the reference ID value for the grant worktag   
Basic_Grant_Data  Basic_Grant_Data  [0..1]  Element containing basic Grant data for a grant used as a basic worktag only 
Validation Description
Can not switch an existing non basic worktag only grant to be a basic worktag only.   
 
top
 

Basic_Grant_Data

part of: Basic_Grant
Element containing basic Grant data for a grant used as a basic worktag only
 
Parameter name Type/Value Cardinality Description Validations
Grant_ID  string  [0..1]  Grant ID. This is the Grant unique identifier   
Grant_Name  string  [1..1]  Free form text for a meaningful Grant Name. Grant Name must be unique.   
Inactive  boolean  [0..1]  Boolean to indicate that Grant is inactive   
Validation Description
Can not switch an existing non basic worktag only grant to be a basic worktag only.   
top
 

GrantReferenceEnumeration

part of: GrantObjectID
Base Type
string
top