IAPOPService2024HelloWorld Method

Provincial Approach to Student Information API

The HelloWorld service returns a greeting to the PASI Client and indicates which PASI endpoint is being called. Example: PASI Client calls the HelloWorld service passing in "John", the message "Hello John from the PASI Core Helloworld Service!" will be returned.

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

Syntax

Copy

string HelloWorld(
	HelloWorldRequest request
)

Function HelloWorld ( 
	request As HelloWorldRequest
) As String

Parameters

request: Type: PASI.DataContract.V2009HelloWorldRequest
An instance of the HelloWorldRequest data contract.

Return Value

Type: String
A string that contains a "Hello world" greeting.

Remarks

This is a test service that a PASI Client can use to see if they can call the PASI Core.

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
Value	String	No	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]

Reference

IAPOPService2024 Interface

PASI.ServiceContract Namespace