Ping (POST)

Description

URL

scheme://domain:port/platform/ws/ping

Description

The ping service detects whether or not a web service is running at the specified URL.

HTTP Method

POST

Parameters

 Name Description
 

url

Required. URL to connect to Platform Application Center web services.

Format when HTTPS is not enabled: 

http://host_name:port/platform

Format when HTTPS is enabled: 

https://host_name:port/platform

Request

Request-Method

POST

Request-URI

/platform/ws/ping

Request-Header

Name

Value

Accept

application/xml or application/json

Message-body

url=%s

Response

Response-Code

  • 200 Successful: Request was successful.
  • 400 Bad request: The URL is empty or missing.
  • 500 Internal Server Error: Exception occurred.
  • 503 Service Unavailable: You must have Platform Application Center Standard Edition to use web services.

Response-Header

Name

Value

Content-Type

application/xml or application/json

Message-body

 Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/jobs/error.xsd.

<error>
  <message>
     %s
  </message>
</error>

Example 

# Request
GET /platform/ws/ping HTTP/1.1
Host: www.example.org
Accept: application/xml url=http://192.0.2.0:8080/platform/ws/ping

#Response
200 Successful
Content-Type: application/xml;

 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <Message>
     <message>Web Services are ready on URL: http://192.0.2.0:8080/platform/ws/ping</message>
  </Message>