void ping()

This method tests the connection with the server for the specified connectorName. This test should be called after the construction of the Push API.

The purpose of this method is to:

  • test the server availability

  • check for the existence of the connectorName and its security

  • compare the PAPI Versions X-Papi-Version

This page discusses:

See Also
HTTP encoding

HTTP parameter

The parameter is described in the table below.

Parameter

Location

Description

PAPI_session

[URL]

The optional parameter that retrieves the session given by a previous call to get_current_session_id

Action: if there is a session mismatch, the Push API server refuses the command and returns an exception.

HTTP method

The method used is:

GET http://<host>:<port>/papi/4/connectors/<connectorName>/ping