GET wrapper/ping

(SLPing) Returns the FinScan Web Services and Wrapper versions and verifies they are running

Request Information

URI Parameters

None.

Body Parameters

Wrapper Ping Request LSTServicesPingRequest

LSTServicesPingRequest

None.

Request Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<LSTServicesPingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup" />

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Wrapper And FinScan Versions

LSTServicesPingResponse
NameDescriptionTypeAdditional information
wrapperVersion

The Version of the Wrapper.

string

None.

finscanVersion

The Version of FinScan being called by the Wrapper.

string

None.

status

The Current Status of the call [Pass or Fail].

SLResultTypeEnum

None.

code

A Code Value for the Status/Message returned.

SLWrapperCodes

None.

message

String containing information on the call results including Error details.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "wrapperVersion": "sample string 1",
  "finscanVersion": "sample string 2",
  "status": 0,
  "code": 0,
  "message": "sample string 3"
}

application/xml, text/xml

Sample:
<LSTServicesPingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSTServicesLookup">
  <code>SUCCESS</code>
  <finscanVersion>sample string 2</finscanVersion>
  <message>sample string 3</message>
  <status>PASS</status>
  <wrapperVersion>sample string 1</wrapperVersion>
</LSTServicesPingResponse>