Service Directory > v32.1 > Academic_Foundation > Get_Student_Veterans_Benefits
 

Operation: Get_Student_Veterans_Benefits

Returns Student Veterans Benefits by Reference ID, or returns all Student Veterans Benefits if no Reference ID is provided.


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

Element Container for Get Student Veterans Benefits Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Veteran_Benefits_Request_References  [0..1]  Element Container for Student Veteran Benefits Request References   
Request_Criteria [Choice]   Student_Veteran_Benefits_Request_Criteria  [0..1]  Element Container for Student Veteran Benefits 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_Student_Veterans_Benefits_Response

Element Container for Get Student Veterans Benefits Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Veteran_Benefits_Request_References  [0..1]  Element Container for Student Veteran Benefits Request References   
Request_Criteria  Student_Veteran_Benefits_Request_Criteria  [0..1]  Element Container for Student Veteran Benefits Request Criteria   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element Container for Response Results   
Response_Data  Student_Veteran_Benefits_Response_Data  [0..1]  Element Container for Student Veteran Benefits Response Data   
top
 

Student_Veteran_Benefits_Request_References

part of: Get_Student_Veterans_Benefits_Request, Get_Student_Veterans_Benefits_Response
Element Container for Student Veteran Benefits Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Veteran_Benefits_Reference  Student_Veteran_BenefitsObject  [1..*]  Student Veteran Benefits   
top
 

Student_Veteran_BenefitsObject

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

Student_Veteran_BenefitsObjectID

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

Student_Veteran_Benefits_Request_Criteria

part of: Get_Student_Veterans_Benefits_Request, Get_Student_Veterans_Benefits_Response
Element Container for Student Veteran Benefits Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Veterans_Benefits_Request, Get_Student_Veterans_Benefits_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_Student_Veterans_Benefits_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
 

Student_Veteran_Benefits_Response_Data

part of: Get_Student_Veterans_Benefits_Response
Element Container for Student Veteran Benefits Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Veteran_Benefits  Student_Veteran_Benefits  [0..*]  Element Container for Student Veteran Benefits   
top
 

Student_Veteran_Benefits

part of: Student_Veteran_Benefits_Response_Data
Element Container for Student Veteran Benefits
 
Parameter name Type/Value Cardinality Description Validations
Student_Veteran_Benefits_Reference  Student_Veteran_BenefitsObject  [0..1]  Student Veteran Benefits   
Student_Veteran_Benefits_Data  Student_Veteran_Benefits_Data  [0..*]  Element Container for Student Veteran Benefits Data 
Validation Description
The value for Parent on Active Duty should be false unless the Military Status for Benefits is equal to Child.   
The value for Eligible for Post 9/11 GI Bill should be false unless the Veteran Benefits /Bill is equal to Vocational Rehabilitation and Employment Bill.   
The value for Spouse on Active Duty should be false unless the Military Status for Benefits is equal to Spouse.   
 
top
 

Student_Veteran_Benefits_Data

part of: Student_Veteran_Benefits
Element Container for Student Veteran Benefits Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Veteran Benefits   
Student_Reference  StudentObject  [1..1]  Student for the Student Veteran Benefits   
Military_Relationship  boolean  [0..1]  Military Relationship for Student Veteran Benefits   
Military_Status_for_Benefits_Reference  Military_Status_for_BenefitsObject  [0..1]  Military Status for Benefits for Student Veteran Benefits   
Parent_on_Active_Duty  boolean  [0..1]  Parent on Active Duty for Student Veteran Benefits   
Spouse_on_Active_Duty  boolean  [0..1]  Spouse on Active Duty for Student Veteran Benefits   
Veterans_Bill__Benefit_Reference  Veterans_Bill__BenefitObject  [0..1]  Veterans Bill/Benefit for Student Veteran Benefits   
Eligible_for_the_Post_9_11_GI_Bill  boolean  [0..1]  Eligible for the Post 9/11 GI Bill for Student Veteran Benefits   
Service_History_for_Benefits_Reference  Service_History_for_BenefitsObject  [0..1]  Service History for Benefits for Student Veteran Benefits   
Validation Description
The value for Parent on Active Duty should be false unless the Military Status for Benefits is equal to Child.   
The value for Eligible for Post 9/11 GI Bill should be false unless the Veteran Benefits /Bill is equal to Vocational Rehabilitation and Employment Bill.   
The value for Spouse on Active Duty should be false unless the Military Status for Benefits is equal to Spouse.   
top
 

StudentObject

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

StudentObjectID

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

Military_Status_for_BenefitsObject

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

Military_Status_for_BenefitsObjectID

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

Veterans_Bill__BenefitObject

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

Veterans_Bill__BenefitObjectID

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

Service_History_for_BenefitsObject

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

Service_History_for_BenefitsObjectID

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

Student_Veteran_BenefitsReferenceEnumeration

part of: Student_Veteran_BenefitsObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Military_Status_for_BenefitsReferenceEnumeration

part of: Military_Status_for_BenefitsObjectID
Base Type
string
top
 

Veterans_Bill__BenefitReferenceEnumeration

part of: Veterans_Bill__BenefitObjectID
Base Type
string
top
 

Service_History_for_BenefitsReferenceEnumeration

part of: Service_History_for_BenefitsObjectID
Base Type
string
top