ILearnAlbertaService2026BeginIsDataAvailable Method Provincial Approach to Student Information API
The IsDataAvailable operation allows the caller to check for new data that is available to them.

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

IAsyncResult BeginIsDataAvailable(
	DataNotificationRequest request,
	AsyncCallback callback,
	Object asyncState
)

Parameters

request
Type: PASI.DataContract.V2009DataNotificationRequest
The DataNotificationRequest instance passed from the client to send which data types will be monitored, the current version known on the client.
callback
Type: SystemAsyncCallback
This parameter is not passed or visible by the client. This parameter is passed in by WCF
asyncState
Type: SystemObject
This parameter is not passed or visible by the client. This parameter is passed in by WCF

Return Value

Type: IAsyncResult
A DataNotificationResponse indicating what, if any, data is different in the core than on the client.

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.

3005, 3006, 3007, 3008
Remarks

Since this is a server side asynchronous service operation the service name exposed to the client is IsDataAvailable. The name from the documentation will appear as "BeginIsDataAvailable" but the WSDL will only expose IsDataAvailable and that is the method that clients should call.

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
RegisteredNotificationTypesList<DataNotificationRequestTypeInfo>Yes
RegisteredNotificationTypes.MaxPASICoreVersionInt64Yes
RegisteredNotificationTypes.NotificationTypeStringYes
RegisteredNotificationTypes.PASICoreVersionHashStringNo
WaitTimeInMinutesInt32Yes


Response Fields

Full Property NameTypeRequiredOther Attributes
DataNotificationResponse.NotificationResultTypeInfosList<DataNotificationResultTypeInfo>No
DataNotificationResponse.NotificationResultTypeInfos.IdListList<DataNotificationIdVersion>No
DataNotificationResponse.NotificationResultTypeInfos.IdList.IdStringNo
DataNotificationResponse.NotificationResultTypeInfos.IdList.PASICoreVersionInt64No
DataNotificationResponse.NotificationResultTypeInfos.NotificationTypeStringNo
DataNotificationResponse.NotificationResultTypeInfos.UpdateTypeStringNo
See Also

Reference