Data Element Business Rule Applicable Message Applicable to Continuing Students BirthDate The value of the BirthDate must be greater than the current server date minus 110 years AND the value of the BirthDate must be less than the current server date. Yes SexCode A student record must have a SexCode equal to ‘M’ , ‘F’or ‘X’ 10259 Yes FamilyName Within each PreviousName element, FamilyName is mandatory. 10201 Yes CitizenshipStatus Code A student must have a CitizenshipStatusCode equal to ‘1’, ‘2’, ‘3’, ‘4’, ‘5’ or ‘8’. 10205 Yes Year12Details If the value of AttendedYear12Code is equal to ‘AttendedYear12’, THEN Year12Details must be present. 10224 Yes Year12State If the value of AttendedYear12Code is equal to ‘AttendedYear12’ THEN For each record supplied in Year12Details, Year12State must be supplied. 10207 Yes Year12State If the value of AttendedYear12Code is equal to ‘AttendedYear12’, THEN For each record supplied in Year12Details, Year12State must be a Australian state according to the Code Value Source on the CHESSN structure document. 10208 Yes Year12Year If the of AttendedYear12Code is equal to ‘AttendedYear12’, THEN For each record supplied in Year12Details, Year12Year must be supplied. 10209 Yes
HepYear If the value of AttendedPreviousHepCode is equal to ‘AttendedPreviousHep’, THEN For each record supplied in PreviousHepDetails, HepYear must be present. 10215 Yes HepYear If the value of AttendedPreviousHepCode is equal to ‘AttendedPreviousHep’, THEN For each record supplied in PreviousHepDetails, HepYear must be less than or equal to the current year AND HepYear must be greater than the current year minus 100 years. 10229 Yes ClientOrganisationCode Only a valid Higher Education Provider can request a CHESSN for a continuing student. 10260 Yes PostCode Within the PostalAddress element, if CountryCode is equal to ‘1100’ (Australia) THEN PostCode must be present. 10218 No PostCode Within the PostalAddress element, if CountryCode is provided AND CountryCode is equal to ‘1100’ (Australia), THEN PostCode must be a value in the range of ‘0001’ to ‘9999’. 10230 Yes CountryCode Within the PostalAddress element, if the CountryCode is provided THEN CountryCode must be valid according to Appendix C on HEIMSHELP. 10216 Yes CHESSN Duplicate Handling
control Request The RequestControlTable should contain the RequestId of the original batch GetStudentEntitlement method call. Please refer to: Appendix D.1 – Schema definition for RequestControlTable Business Rules Because a call to GetStudentEntitlementResults contains no input transaction data, no business rules are applicable for this method. For business rules relating to the retrieval of student entitlement details in general, please see section 5.6. Return Type XML Type Description heims:GetEntitlementBatchResponse The batch response object. The GetEntitlementBatchResponse schema defines one ResponseControlTable element and can contain multiple GetEntitlementOut elements. Each GetEntitlementOut element will contain student entitlement information such as Ordinary SLE usage and FEE-HELP Loan balance. Please refer to: Appendix D.6 – Schema definition for GetEntitlementBatchResponse Appendix D.5 – Schema definition for GetEntitlementOut Appendix D.1 – Schema definition for ResponseControlTable Request Messages RequestStatusCode Condition Applicable Message Codes FAILURE There appears to be a problem with your access. Please contact the HEIMS IT Liaison officer. 10007 FAILURE Access to this particular function is denied. Please contact the HEIMS IT Liaison officer. FAILURE The RequestId given does not match an existing request. 7 FAILURE Invalid ClientOrganisationCode provided. 12 FAILURE Access to send or view results for the ClientOrganisationCode provided is denied. 11 FAILURE An existing RequestId was provided, but the RequestId was not for a batch GetStudentEntitlement method. 10 FAILURE The RequestDateTime is not valid. 14 PROCESS Processing for this request has not finished. 1 – 6