IPASIService2019SubmitStudentFeeCoupon Method Provincial Approach to Student Information API
A service to create or update a coupon for a student fee

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax

StudentFeeCouponResponse SubmitStudentFeeCoupon(
	SubmitStudentFeeCouponRequest request
)

Parameters

request
Type: PASI.DataContract.V201602SubmitStudentFeeCouponRequest
The student fee coupon

Return Value

Type: StudentFeeCouponResponse
Reference ids and any rejections

Service Validations

The following codes can be returned from the service operation. This list also shows core alerts that could be generated as a result calling this service. These codes are in addition to the standard set of codes that can be returned defined as in the Approach to Error Reporting. Click the link for the details.

9002, 9015, 9062, 40700, 40701, 40702, 40703, 40705, 40706, 40707, 60003
Remarks

Request and Response Class Diagram



Request Fields

Full Property NameTypeRequiredOther Attributes
CallerInfoCallerInfoYes
CallerInfo.ClientMessageIDStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.SentUtcTimeDateTimeYes
CallerInfo.SoftwareSoftwareYes
CallerInfo.Software.BuildNumberStringYesValue must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.ManufacturerStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.ProductStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.VersionStringYesValue must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.UserUserYes
CallerInfo.User.IPAddressStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.LocalIDStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.NameStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.OrganizationCodeStringYesValue must be no more than 6 characters
StudentFeeCouponsList<StudentFeeCouponRequestInfo>Yes
StudentFeeCoupons.CourseCodeStringYesValue must be 7 characters
StudentFeeCoupons.ExpiryExamPeriodStringYesValue must be an appropriate ExamPeriod code value
StudentFeeCoupons.ExpirySchoolYearInt16YesValue must be between 1900 and 2100
StudentFeeCoupons.IsDeletedBooleanYes
StudentFeeCoupons.ReasonStringYesValue must be no more than 1000 characters
StudentFeeCoupons.RefIdGuidYes
StudentFeeCoupons.StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'


Response Fields

Full Property NameTypeRequiredOther Attributes
StudentFeeCouponResponse.StudentFeeCouponsList<StudentFeeCouponResponseInfo>No
StudentFeeCouponResponse.StudentFeeCoupons.RefIdGuidNo
StudentFeeCouponResponse.StudentFeeCoupons.RejectionsList<Rejection>No
StudentFeeCouponResponse.StudentFeeCoupons.Rejections.CodeStringYes
StudentFeeCouponResponse.StudentFeeCoupons.Rejections.DescriptionStringYes
See Also

Reference