IPASIService2019GetSection Method Provincial Approach to Student Information API
This service will return the Section(s) based on the Section Id(s) passed in.

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

List<SectionResponse> GetSection(
	SectionRequest request
)

Parameters

request
Type: PASI.DataContract.V201204SectionRequest
The request contains a list of Section Ids the client wishes to retrieve.

Return Value

Type: ListSectionResponse
The response contains a list of Sections.

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.

No additional errors for this service.
Remarks

This service is intended to be used during the data synchronization process using the IsDataAvailable service. See the Expected Versions section for important details on how this service will return data.

This service allows the PASI Client to retrieve Section(s) by passing in the Section RefId(s). Any section can be retrieved by a PASI Client but the IsDataAvailable service will only notify organizations that own the section record.

The PASI Client must be assigned the ViewAcademicRecordUser role before they are able to call this service.

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
SectionIdsList<EntityRefIdVersionInfo>Yes
SectionIds.ExpectedVersionNullable`1No
SectionIds.RefIdGuidYes


Response Fields

Full Property NameTypeRequiredOther Attributes
List<SectionResponse>List<SectionResponse>No
List<SectionResponse>.AvailabilityStatusStringNo
List<SectionResponse>.SectionSectionInfoNo
List<SectionResponse>.Section.CourseCodesList<String>Yes
List<SectionResponse>.Section.CreditsOfferedInt16Yes
List<SectionResponse>.Section.DeliveryScheduleStringYesValue must be an appropriate SectionDeliverySchedule code value
List<SectionResponse>.Section.DescriptionStringYesValue must be no more than 255 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]
List<SectionResponse>.Section.EffectiveUtcDateTimeNo
List<SectionResponse>.Section.EndDateDateTimeNo
List<SectionResponse>.Section.InstructionalLanguageStringYesValue must be an appropriate InstructionalLanguage code value
List<SectionResponse>.Section.InstructionalMinutesOfferedNullable`1NoValue must be between 0 and 32767
List<SectionResponse>.Section.IsDeletedBooleanYes
List<SectionResponse>.Section.LocalSectionIdStringNoValue must be no more than 8 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]
List<SectionResponse>.Section.PASICoreVersionInt64Yes
List<SectionResponse>.Section.PrimaryDeliveryMethodStringYesValue must be an appropriate PrimaryDeliveryMethod code value
List<SectionResponse>.Section.RefIdGuidYes
List<SectionResponse>.Section.SchoolCodeStringYesValue must be in the form of a number between '0001' and '9999'
List<SectionResponse>.Section.SchoolYearInt16YesValue must be between 1900 and 2100
List<SectionResponse>.Section.SectionTermStringYesValue must be an appropriate SectionTerm code value
List<SectionResponse>.Section.StartDateDateTimeNo
See Also

Reference