Service Directory > v32.1 > Academic_Foundation > Put_Student_Veteran_Benefits
 

Operation: Put_Student_Veteran_Benefits

Creates a new Student Veteran Benefits (or updates an existing Student Veteran Benefits) with the information supplied in the request.


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

Element Container for Put Student Veteran Benefits Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add only field for Student Veteran Benefits Request   
Student_Veteran_Benefits_Reference  Student_Veteran_BenefitsObject  [0..1]  Student Veteran Benefits   
Student_Veteran_Benefits_Data  Student_Veteran_Benefits_Data  [1..1]  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.   
 
Validation Description
The web service is set to add only, but the Student Veteran Benefits already exists.   
The student specified is different from the existing student associated with the student veteran benefits.   
top
 

Response Element: Put_Student_Veteran_Benefits_Response

Element container for Put Student Veteran Benefits Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Veteran_Benefits_Reference  Student_Veteran_BenefitsObject  [0..1]  Student Veteran Benefits   
top
 

Student_Veteran_BenefitsObject

part of: Put_Student_Veteran_Benefits_Response, Put_Student_Veteran_Benefits_Request
 
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_Data

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