Versjon: 2.1.14297
The Web
Service includes methods to authenticate user, get user Ticket/Security token,
get user information, create or modify user and to set an active role for the
user.
The
AuthenticationWS Web Service contains these methods:
The Web Service reference is: AuthenticationWS.asmx
Open in a
Web Browser for more detailed information about each method. The Web Service's WSDL, SOAP request and
response is described.
For more
detailed information as the Web Service's WSDL, SOAP request and response see:
https://linkws.service.tieto.com/PasLinkWS/AuthenticationWS/AuthenticationWS.asmx
Applicable
systems for method:
|
INFOMEDIX |
Classic |
HIS-90 |
HL7 |
RoS |
OFSP |
MasterPAS |
Description:
Checks whether the user/password is valid. Returns
XML element Ticket/Security
token which must be used when
calling other Web Services. The Ticket/Security token is sent in by the
SOAP header request object. The user's combination of roles and accesstemplates
are also returned if HIS is INFOMEDIX.
Syntax:
Authentication = GetUserLogin(UserName, Password,
SystemCode, UnitId, CSLSection)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
UserName |
String |
N/A Dynamic |
User
name defined in HIS |
|
Password |
String |
N/A Dynamic |
Password
defined in HIS |
|
SystemCode |
String |
N/A Dynamic |
System code to identify
system. INFOMEDIX: Not used Classic: Not used HIS90: Required. Example: PA (pas/sql), KK (Clinical lab), ML(Microbiologi Lab),
BB(Blodbank). |
|
UnitId |
String |
N/A Dynamic |
Unit that user is
authenticated in. INFOMEDIX: Not used Classic: Not used HIS90: Required if HIS is HIS90. |
|
CSLSection |
String |
N/A Dynamic |
The CSL Section is used to define wich Pathway
system is to be used by user. INFOMEDIX: Not used Classic: Not used HIS90: Required if HIS is HIS90. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
Authentication |
|
N/A Dynamic |
AuthenticationInfo
is an XML element which must be used when
calling other Web Services. |
|
|
|
|
|
Schema for GetUserLogin: UserLoginResponse.xsd
Schema
documentation for GetUserLogin: UserLoginResponse.html
XML
sample file for GetUserLogin: UserLoginResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/AuthenticationWS/AuthenticationWS.asmx?op=GetUserLogin
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain a system name. The
Authentication Block should be empty. An error will be raised if something is
missing.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
INFOMEDIX |
|
|
|
|
|
|
Description:
Sets the user's active (default) role/access
template to be used in later Web Service calls.
This method is typically called after GetUserLogin
and the user has changed the active role/access template. The method is only
used if the calling system wants to use the INFOMEDIX login module.
Syntax:
Authentication
= SetActiveRoleAccessTemplate(RoleId, AccessTemplateId)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
RoleId |
Number |
4 |
Internal
role id for INFOMEDIX. |
|
AccessTemplateId |
Number |
4 |
Internal
access template id for INFOMEDIX. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
Authentication |
|
N/A Dynamic |
AuthenticationInfo
is an XML element which must be used when
calling other Web Services. |
Web Service Response and Request:
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader
must contain a valid Authentication Block and the system name is required. An
error will be raised if one of these is missing.
Valid
Authentication Block for ResponseHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
INFOMEDIX |
HIS90 |
HL7 |
MasterPAS |
|
|
|
Description:
Gets the
user's id from the ticket. The user id include any other information as
template, unit, system or role to make the id unique. But it can also only
return the users id in in the PAS system.
Syntax:
UserId =
GetUserId(OnlyUserId)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
OnlyUserId |
Boolean |
4 |
INFOMEDIX: Internal
role id for INFOMEDIX. |
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
UserId |
String |
N/A Dynamic |
User
Id |
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/AuthenticationWS/AuthenticationWS.asmx?op=GetUserId
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader
must contain a valid Authentication Block and the system name is required. An
error will be raised if one of these is missing.
Valid
Authentication Block for ResponseHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
Applicable
systems for method:
|
INFOMEDIX |
HIS90 |
|
|
|
|
|
Description:
Change the
password of a user. The password of the
calling user, or the password of a specified user (calling user must be a
database administrator).
Syntax:
ChangePasswordRequest
= ChangePassword(ChangePasswordResponse)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
ChangePasswordRequest |
|
N/A Dynamic |
ChangePasswordRequest class according to XML
schema ChangePasswordRequest.xsd. .
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
ChangePasswordResponse |
|
N/A Dynamic |
ChangePasswordResponse class according to XML
schema ChangePasswordResponse.xsd. |
Schema for ChangePasswordRequest: ChangePasswordRequest.xsd
Schema
documentation for ChangePasswordRequest: ChangePasswordRequest.html
XML
sample file for ChangePasswordRequest: ChangePasswordRequest.xml
Schema for ChangePasswordResponse: ChangePasswordResponse.xsd
Schema
documentation for ChangePasswordResponse: ChangePasswordResponse.html
XML
sample file for ChangePasswordResponse: ChangePasswordResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/AuthenticationWS/AuthenticationWS.asmx?op=ChangePassword
Related
methods or functions used:
GetUserLogin Used
to verify a user, and to get a valid authentication Block in return.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader
must contain a valid Authentication Block and the system name is required. An
error will be raised if one of these is missing.
Valid
Authentication Block for RequestHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
When using
this methode for HIS-90 for modifying password and the password user himself is
the requester than a new updated Authentication Block is returned by the
method.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
Create a
new user or modify an existing one.
Syntax:
SaveUserResponse
= SaveUser(SaveUserRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
SaveUserRequest |
|
N/A Dynamic |
SaveUserRequest class according to XML
schema AuthenticationWS.xsd. .
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
SaveUserResponse |
|
N/A Dynamic |
SaveUserResponse class according to XML
schema AuthenticationWS.xsd. |
Schema for SaveUserRequest: Authentication.xsd
Schema
documentation for SaveUserRequest: SaveUserRequest.html
XML
sample file for SaveUserRequest: SaveUserRequest.xml
Schema for SaveUserResponse: Authentication.xsd
Schema
documentation for SaveUserResponse: SaveUserResponse.html
XML
sample file for SaveUserResponse: SaveUserResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/AuthenticationWS/AuthenticationWS.asmx?op=SaveUser
Related
methods or functions used:
GetUser Get
one user - Ask about information about one spesific user. Used in SaveUser for
verifying if user is created before and is to be modified and/or to get user
information.
ChangePassword When
creating a new user, using method SaveUser, a new password is in input and is
to be created for the user. But when a user password is to be modified method
ChangePassword is to be used.
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader
must contain a valid Authentication Block and the system name is required. An
error will be raised if one of these is missing.
Valid
Authentication Block for ResponseHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS90 Specified information.
Server
ACO06S is used for thes service. The server updates userinformation in
Easy-file ACDPERS. Following input control is implemented.
Following
message is given if the is no error when
the server runs: “SaveUser – Ok”.
In case of an error following messages may be given: MINST 3 ULIKE TEGN I PASSORD, MINIMUM 4 TEGN I PASSORD, IKKE GODKJENT
PASSORD, UGYLDIG PERSONNUMMER.
Applicable
systems for method:
|
HIS90 |
|
|
|
|
|
|
Description:
The method
is used for retreaving user information for a selected user.
Syntax:
GetUserResponse
= GetUser(GetUserRequest)
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
GetUserRequest |
|
N/A Dynamic |
GetUserRequest class according to XML
schema AuthenticationWS.xsd. .
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
GetUserResponse |
|
N/A Dynamic |
GetUserResponse class according to XML
schema AuthenticationWS.xsd. |
Schema for GetUserRequest: Authentication.xsd
Schema
documentation for GetUserRequest: GetUserRequest.html
XML
sample file for GetUserRequest: GetUserRequest.xml
Schema for GetUserResponse: Authentication.xsd
Schema
documentation for GetUserResponse: GetUserResponse.html
XML
sample file for GetUserResponse: GetUserResponse.xml
Web Service Response and Request:
See https://linkws.service.tieto.com/PasLinkWS/AuthenticationWS/AuthenticationWS.asmx?op=GetUserId
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader
must contain a valid Authentication Block and the system name is required. An
error will be raised if one of these is missing.
Valid
Authentication Block for ResponseHeader
the can be retrieved by using the method GetUserLogin
in Authentication-Web Service.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.
HIS90 Specified information.
Server used
for GetUser is AC006. This server is used for getting user information from
Easy.
The server
gets user information (B-date, P-No) from Easy-file ACDPERS. The message GetUser – Ok means that the retrieve has
been successful. In case the user is not found the server issues follwing
message “USER-ID FINNES IKKE “
Applicable
systems for method:
ALL
SYSTEMS !
Description:
Gets information about which PAS system the
PasLink Web Service is configured for and the countrycode if it exista in the
PasLinkWS configuration.
The method can be called without any
ticket/security token from GetUserLogin, any application using PasLinkWS can
then chech system and country code before logging on to PasLinkWS.
Syntax:
GetSystemInformationResponse = GetSystemInformation()
|
Parameter
in |
Type |
Length
byte |
Description
– Data format – Valid data |
|
No input parameters |
N/A |
N/A Dynamic |
|
|
Returned
parameter |
Type |
Length
Byte |
Description
– Comments |
|
HIS System |
String |
N/A Dynamic |
Type of system PasLinkWS
is configured for. Can be: INFOMEDIX ROS CLASSIC HIS90 MINIPAS OFSP HL7 |
|
CountryCode |
String |
N/A Dynamic |
Country
code PasLinkWS is configured for. Can be: NO SE DK |
Schema for GetSystemInformation: Authentication.xsd
Schema
documentation for GetSystemInformation: GetSystemInformationResponse.html
XML
sample file for GetSystemInformation: GetSystemInformationResponse.xml
Web Service Response and Request:
Other
references:
RequestHeader Information required calling a method, containing
authentication information.
ResponseHeader Information and messages returned from the method, e.g.
error codes/description,
system name or version.
Comments:
To use this
method the RequestHeader must contain a system name. The
Authentication Block should be empty. An error will be raised if something is
missing.
In return
from the method there will always be a ResponseHeader,
which contains Error Information and System Information. Error Information
block must always be checked to determine if any error has occurred while
processing the methods.