Service Directory > v32.1 > Revenue_Management > Get_Award_Proposal_Submission_Types
 

Operation: Get_Award_Proposal_Submission_Types

This service operation will get Award Proposal Submission Types based on request criteria, or all Award Proposal Submission Types if no request criteria is provided. Award Proposal Submission Type Data includes Award Proposal Submission Type Reference ID and Award Proposal Submission Type Name.


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

This element is the top-level request element for all Award Proposal Submission Type "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Award_Proposal_Submission_Type_Request_References  [0..1]  This element content contains the Award Proposal Submission Type reference element used to return Award Proposal Submission Type by reference id.   
Request_Criteria [Choice]   Award_Proposal_Submission_Type_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Award Proposal Submission Type.   
Response_Filter  Response_Filter  [0..1]  Element content containing Award Proposal Submission Type Response Filter element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Award_Proposal_Submission_Type_Response_Group  [0..1]  Element content containing Award Proposal Submission Type Response Group element   
top
 

Response Element: Get_Award_Proposal_Submission_Types_Response

Element containing Award Proposal Submission Type response elements including echoed request data and request result
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Award_Proposal_Submission_Type_Request_References  [0..1]  Award Proposal Submission Type Reference element contains the set of requested Award Proposal Submission Types for which to return data.   
Request_Criteria  Award_Proposal_Submission_Type_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Award Proposal Submission Type specific 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  Award_Proposal_Submission_Type_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Award Proposal Submission Type 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  Award_Proposal_Submission_Type_Response_Data  [0..1]  Wrapper element containing Award Proposal Submission Type Response Data for requested references or criteria   
top
 

Award_Proposal_Submission_Type_Request_References

part of: Get_Award_Proposal_Submission_Types_Request, Get_Award_Proposal_Submission_Types_Response
Award Proposal Submission Type Reference element contains the set of requested Award Proposal Submission Types for which to return data.
 
Parameter name Type/Value Cardinality Description Validations
Award_Proposal_Submission_Type_Reference  Award_Proposal_Submission_TypeObject  [1..*]  Reference Award Proposal Submission Type for which data will be returned   
top
 

Award_Proposal_Submission_TypeObject

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

Award_Proposal_Submission_TypeObjectID

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

Award_Proposal_Submission_Type_Request_Criteria

part of: Get_Award_Proposal_Submission_Types_Request, Get_Award_Proposal_Submission_Types_Response
This element is the wrapper around a list of elements representing the Award Proposal Submission Type specific criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Award_Proposal_Submission_Types_Request, Get_Award_Proposal_Submission_Types_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
 

Award_Proposal_Submission_Type_Response_Group

part of: Get_Award_Proposal_Submission_Types_Request, Get_Award_Proposal_Submission_Types_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Award Proposal Submission Type response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Award Proposal Submission Type Reference data is to be included in the response   
top
 

Response_Results

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

Award_Proposal_Submission_Type_Response_Data

part of: Get_Award_Proposal_Submission_Types_Response
Wrapper element containing Award Proposal Submission Type Response Data for requested references or criteria
 
Parameter name Type/Value Cardinality Description Validations
Award_Proposal_Submission_Type  Award_Proposal_Submission_Type  [0..*]  The response for a request for Award Proposal Submission Type data.   
top
 

Award_Proposal_Submission_Type

part of: Award_Proposal_Submission_Type_Response_Data
Wrapper Element containing an Award Proposal Submission Type Reference and all data for the single Award Proposal Submission Type.
 
Parameter name Type/Value Cardinality Description Validations
Award_Proposal_Submission_Type_Reference  Award_Proposal_Submission_TypeObject  [0..1]  The Award Proposal Submission Type for which data is returned.   
Award_Proposal_Submission_Type_Data  Award_Proposal_Submission_Type_Data  [0..*]  Contains all References and Attributes to represent a complete Award Proposal Submission Type.   
top
 

Award_Proposal_Submission_Type_Data

part of: Award_Proposal_Submission_Type
Contains all References and Attributes to represent a complete Award Proposal Submission Type.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Award Proposal Submission Type Reference ID. This is the Award Proposal Submission Type Unique Identifier.   
Name  string  [1..1]  The Award Proposal Submission Type Name. 
Validation Description
This Award Proposal Submission Type Name has already been used. Please specify another.  This Award Proposal Submission Type Name has already been used. Please specify another. 
 
Inactive  boolean  [0..1]  The Award Proposal Submission Type Inactive flag.   
top
 

Award_Proposal_Submission_TypeReferenceEnumeration

part of: Award_Proposal_Submission_TypeObjectID
Base Type
string
top