Service Directory > v32.1 > Student_Finance > Get_Student_Payment_Sessions
 

Operation: Get_Student_Payment_Sessions

Gets Student Payment Session for processing in the Integration System


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

Get Request Element for Student Payment Session
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Payment_Session_Request_References  [0..1]  Student Payment Session References Element   
Request_Criteria [Choice]   Student_Payment_Session_Request_Criteria  [0..1]  Student Payment Session Criteria Element   
Response_Filter  Response_Filter  [0..1]  Response Filters 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Payment_Sessions_Response

Get Student Payment Sessions Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Payment_Session_Request_References  [0..1]  Mirrors Back Request References   
Request_Criteria  Student_Payment_Session_Request_Criteria  [0..1]  Mirrors Back Request Criteria   
Response_Filter  Response_Filter  [0..1]  Mirrors Back Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Results Info   
Response_Data  Student_Payment_Session_Response_Data  [0..1]  Student Payment Session Response Data Element   
top
 

Student_Payment_Session_Request_References

part of: Get_Student_Payment_Sessions_Request, Get_Student_Payment_Sessions_Response
Student Payment Session References Element
 
Parameter name Type/Value Cardinality Description Validations
Student_Payment_Session_Reference  Student_Payment_SessionObject  [1..*]  Student Payment Session References   
top
 

Student_Payment_SessionObject

part of: Student_Payment_Session_Request_References, Student_Payment_Session
 
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_Request_Criteria

part of: Get_Student_Payment_Sessions_Request, Get_Student_Payment_Sessions_Response
Student Payment Session Criteria
 
Parameter name Type/Value Cardinality Description Validations
Integration_Invocation_Reference  Integration_ESB_Invocation__Abstract_Object  [0..1]  The Integration Event that is triggered by the Student Payment Session   
top
 

Integration_ESB_Invocation__Abstract_Object

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

Integration_ESB_Invocation__Abstract_ObjectID

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

Response_Filter

part of: Get_Student_Payment_Sessions_Request, Get_Student_Payment_Sessions_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_Payment_Sessions_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_Payment_Session_Response_Data

part of: Get_Student_Payment_Sessions_Response
Student Payment Sesssion Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Payment_Session  Student_Payment_Session  [0..*]  Student Payment Session Element   
top
 

Student_Payment_Session

part of: Student_Payment_Session_Response_Data
Student Payment Session Element
 
Parameter name Type/Value Cardinality Description Validations
Student_Payment_Session_Reference  Student_Payment_SessionObject  [0..1]  Student Payment Session Instance   
Student_Payment_Session_Data  Student_Payment_Session_Data  [0..*]  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.   
 
top
 

Student_Payment_Session_Data

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

Integration_ESB_Invocation__Abstract_ReferenceEnumeration

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