Service Directory > v31.2 > Student_Finance > Put_Student_Payment_Session
 

Operation: Put_Student_Payment_Session

Edits a Student Payment Session to Update the URL for the External Site.


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

Put Student Payment Session Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Whether this will Only Add a Student Payment Session   
Student_Payment_Session_Reference  Student_Payment_SessionObject  [0..1]  student payment session reference   
Student_Payment_Session_Data  Student_Payment_Session_Data  [1..1]  Student Payment Session Data 
Validation Description
Put Student Payment Session webservice can only be used to update the delayed URL, no other field should be included in the request.   
 
Validation Description
Student payment session cannot be created via web service. Please provide a reference to an existing student payment session   
top
 

Response Element: Put_Student_Payment_Session_Response

Put Student Payment Session Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Payment_Session_Reference  Student_Payment_SessionObject  [0..1]  Student Payment Session Instance Edited   
top
 

Student_Payment_SessionObject

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

Student_Payment_SessionObjectID

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

part of: Put_Student_Payment_Session_Request
Data for Student Payment Session
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID   
Student_Reference  StudentObject  [0..1]  Student Who Initiated the Payment Session   
Student_Payment_Item_Reference  Student_Payment_ItemObject  [0..1]  Payment Item Student is Paying   
Student_First_Name  string  [0..1]  First Name of the Student   
Student_Last_Name  string  [0..1]  Last Name of the Student   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Academic Period the Student is Applying their payment toward   
Delayed_URL  string  [0..1]  URL to Third Party Vendor, Write-Only   
Currency_Reference  CurrencyObject  [0..1]  Currency of the Expected Payment   
Payment_Session_Amount  decimal (22, 2) >0   [0..1]  Amount of the Payment Session   
Validation Description
Put Student Payment Session webservice can only be used to update the delayed URL, no other field should be included in the request.   
top
 

StudentObject

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

Student_Payment_ItemObject

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

Student_Payment_ItemObjectID

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

Academic_PeriodObject

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

Academic_PeriodObjectID

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

CurrencyObject

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

CurrencyObjectID

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

part of: Student_Payment_SessionObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Student_Payment_ItemReferenceEnumeration

part of: Student_Payment_ItemObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top