XML API ping
Overview
NOTICE Service-disruption hazard |
The following sample message is an example of the request format.
Use the sample as a base to build your request. Ensure that you test your request before network deployment.
The XML API ping method is used to monitor the HTTP connection to the NFM-P.
Figure 5-1, XML interface check request shows an XML API ping that you can use to test the ability of the OSS application to access the NFM-P. Information in the SOAP/XML request includes the:
Figure 5-1: XML interface check request
<?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 hashed="false">password</password> |
</security> |
<requestID>XML_API_client@n</requestID> |
</header> |
</SOAP:Header> |
<SOAP:Body> |
<ping xmlns="xmlapi_1.0"/> |
</SOAP:Body> |
</SOAP:Envelope> |
The following figure is a code example of a successful response message to the ping request. The response indicates that the correct server XML version, 1.0, responded to the ping.
Figure 5-2: XML interface check response
<?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> |
An exception response to a failed ping may result in numerous types of return messages; for example: