The OSS client cannot communicate with the server

Introduction

The following XML API ping sample can be used to test whether the OSS application can access the NFM-P server. Information in the SOAP/XML request includes:

  • standard SOAP user and password encoding

  • the ping command to look for the release of XML on the server, which in this case, is Release 1.0

An exception response to a failed ping may result in many types of return messages, for example:

  • socket timeouts

  • HTTP errors

  • connection exceptions

Steps
 
1 

Run a ping command similar to the following in Figure C-1, Ping request example .

Figure C-1: Ping request example
<?xml version="1.0" encoding="UTF-8"?>
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP:Header>
      <header xmlns="xmlapi_1.0">
         <security>
            <user>username</user>
            <password>password</password>
         </security>
         <requestID>XML_API_client@n</requestID>
      </header>
   </SOAP:Header>
   <SOAP:Body>
      <ping xmlns="xmlapi_1.0"/>
   </SOAP:Body>
</SOAP:Envelope>
2 

Review the three-digit HTTP response code.

  • 200 to 299—indicates success; client-server communication is not the problem

  • 400 to 499—indicates that the error is on the client side; the request contains incorrect XML syntax, or cannot be fulfilled

  • 500 to 599—indicates that the error is on the server; the request is not the problem

3 

Check the XML API response for any indication of other communication problems. Figure C-2, Ping response message is a successful response message to the ping. The response indicates the correct release 1.0 of XML on the server that responds to the ping.

Figure C-2: Ping response message
<?xml version="1.0" encoding="UTF-8"?>
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP:Header>
      <header xmlns="xmlapi_1.0">
         <requestID>XML_API_client@n</requestID>
      </header>
   </SOAP:Header>
   <SOAP:Body>
      <pingResponse xmlns="xmlapi_1.0"/>
   </SOAP:Body>
</SOAP:Envelope>

End of steps