Common Web Service Elements

Web services have the following common elements:

“Connection Information”
“Result Information”

Connection Information

Connection information is specified in each Data Server web service request. Each of the web service functions performs its own connection to Longview. Therefore, each function contains a common section to define the parameters required to establish this connection.

The connection is specified in a similar manner to the following:

<sym:connInfo>

<dat:user>admin</dat:user>

<dat:password>Admin99</dat:password>

<dat:dataServerName>work_dataserver</dat:dataServerName>

<dat:role>Administrator_Access</dat:role>

<dat:group>Administrators</dat:group>

</sym:connInfo>

Element.Attribute	Value	Notes
User	A Longview user name
Password	A Longview user password	If a Longview user password includes special characters, such as <, >, & and %, you must pass these characters as XML entities (<, >, and &, respectively). For example, if the password is password&, type password&.
dataServerName	A Data Server name	This is the Data Server name.
Role	A Longview user role	This is the symbol access role. If the Data Server is configured to use V3 Compatible Access, this parameter is ignored.
Group	A Longview group ID	This is required only if the Data Server is configured to use V3 Compatible Access.

Result Information

Many Data Server web service responses have the status element as part of the response. In some cases, this status structure may be the entire response. In other cases, it supplements other response fields.

The result information is specified in a similar manner to the following:

<_:Response>

<type>Error </type>

<message>Invalid Schedule Name (S1043)</message>

</status>

</_:Response>

Element.Attribute	Value	Notes
Type		This is the status type.
Code	An integer	This is the return code. 0 indicates a successful result. A negative number indicates an Error or Warning
Message	A description of the Status	This is the warning or error message.

Published: January 07, 2024 09:10

Common Web Service Elements

Web services have the following common elements:

“Connection Information”
“Result Information”

Connection Information

The connection is specified in a similar manner to the following:

<sym:connInfo>

<dat:user>admin</dat:user>

<dat:password>Admin99</dat:password>

<dat:dataServerName>work_dataserver</dat:dataServerName>

<dat:role>Administrator_Access</dat:role>

<dat:group>Administrators</dat:group>

</sym:connInfo>

Element.Attribute	Value	Notes
User	A Longview user name
Password	A Longview user password	If a Longview user password includes special characters, such as <, >, & and %, you must pass these characters as XML entities (<, >, and &, respectively). For example, if the password is password&, type password&.
dataServerName	A Data Server name	This is the Data Server name.
Role	A Longview user role	This is the symbol access role. If the Data Server is configured to use V3 Compatible Access, this parameter is ignored.
Group	A Longview group ID	This is required only if the Data Server is configured to use V3 Compatible Access.

Result Information

The result information is specified in a similar manner to the following:

<_:Response>

<type>Error </type>

<message>Invalid Schedule Name (S1043)</message>

</status>

</_:Response>

Element.Attribute	Value	Notes
Type		This is the status type.
Code	An integer	This is the return code. 0 indicates a successful result. A negative number indicates an Error or Warning
Message	A description of the Status	This is the warning or error message.

22990944087693

Common Web Service Elements

Connection Information

Result Information

Common Web Service Elements

Connection Information

Result Information

For an optimal Community experience, Please view on Desktop