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
Parameters
- request
- Type: PASI.DataContract.V201204SectionRequest
The request contains a list of Section Ids the client wishes to retrieve.
Return Value
Type: ListSectionResponseThe 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 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 Name | Type | Required | Other Attributes |
---|---|---|---|
CallerInfo | CallerInfo | Yes | |
CallerInfo.ClientMessageID | String | Yes | Value 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.SentUtcTime | DateTime | Yes | |
CallerInfo.Software | Software | Yes | |
CallerInfo.Software.BuildNumber | String | Yes | Value 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.Manufacturer | String | Yes | Value 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.Product | String | Yes | Value 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.Version | String | Yes | Value 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.User | User | Yes | |
CallerInfo.User.IPAddress | String | Yes | Value 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.LocalID | String | Yes | Value 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.Name | String | Yes | Value 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.OrganizationCode | String | Yes | Value must be no more than 6 characters |
SectionIds | List<EntityRefIdVersionInfo> | Yes | |
SectionIds.ExpectedVersion | Nullable`1 | No | |
SectionIds.RefId | Guid | Yes |
Response Fields
Full Property Name | Type | Required | Other Attributes |
---|---|---|---|
List<SectionResponse> | List<SectionResponse> | No | |
List<SectionResponse>.AvailabilityStatus | String | No | |
List<SectionResponse>.Section | SectionInfo | No | |
List<SectionResponse>.Section.CourseCodes | List<String> | Yes | |
List<SectionResponse>.Section.CreditsOffered | Int16 | Yes | |
List<SectionResponse>.Section.DeliverySchedule | String | Yes | Value must be an appropriate SectionDeliverySchedule code value |
List<SectionResponse>.Section.Description | String | Yes | Value 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.EffectiveUtc | DateTime | No | |
List<SectionResponse>.Section.EndDate | DateTime | No | |
List<SectionResponse>.Section.InstructionalLanguage | String | Yes | Value must be an appropriate InstructionalLanguage code value |
List<SectionResponse>.Section.InstructionalMinutesOffered | Nullable`1 | No | Value must be between 0 and 32767 |
List<SectionResponse>.Section.IsDeleted | Boolean | Yes | |
List<SectionResponse>.Section.LocalSectionId | String | No | Value 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.PASICoreVersion | Int64 | Yes | |
List<SectionResponse>.Section.PrimaryDeliveryMethod | String | Yes | Value must be an appropriate PrimaryDeliveryMethod code value |
List<SectionResponse>.Section.RefId | Guid | Yes | |
List<SectionResponse>.Section.SchoolCode | String | Yes | Value must be in the form of a number between '0001' and '9999' |
List<SectionResponse>.Section.SchoolYear | Int16 | Yes | Value must be between 1900 and 2100 |
List<SectionResponse>.Section.SectionTerm | String | Yes | Value must be an appropriate SectionTerm code value |
List<SectionResponse>.Section.StartDate | DateTime | No |
See Also