PSS API Services - Message Format

Message Format

The same message format is used by different API's and is where the error information is placed in the event of an ERROR; the actual content will vary for each different message.

Response Parameter(s)

Parameter	Type	Length	Description
Message	string
messageDetail	string	255	States the details of the message.
messageType	string	255	Indicates the type of message being displayed.

SOAP Request

Example from Contract:

    i.cisco.com/pss/v1.0/ContractService HTTP/1.1
    Accept-Encoding: gzip,deflate
    Content-Type: text/xml;charset=UTF-8
    SOAPAction: "getContractCoverageDetails"
    Authorization: Bearer v4f2mjcbjftspr8zuvnaen2n
    User-Agent: Jakarta Commons-HttpClient/3.1
    Host: api.cisco.com
    Content-Length: 475
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
        xmlns:con="http://www.cisco.com/ContractService"›
        ‹soapenv:Header/›
        ‹soapenv:Body›
            ‹con:ContractCoverageRequest›
                ‹con:customerId›1703‹/con:customerId›
                ‹con:inventoryId›15225‹/con:inventoryId›
                ‹!--Zero or more repetitions:--›
                ‹con:deviceIds›‹/con:deviceIds›
            ‹/con:ContractCoverageRequest›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›
            

SOAP Response

    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
        ‹soapenv:Body›
            ‹con:ContractCoverageResponse xmlns:con="http://www.cisco.com/ContractService" 
            xmlns:fn="http://www.cisco.com/FNAlertService" 
            xmlns:hweox="http://www.cisco.com/HwEoxAlertService" 
            xmlns:inv="http://www.cisco.com/InventoryService" 
            xmlns:sweox="http://www.cisco.com/SwEoxAlertService" 
            xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance" 
            xmlns:is="http://www.cisco.com/ISAlertService" 
            xmlns:psirt="http://www.cisco.com/PSIRTAlertService"›
                ‹con:responseTimestamp w3c:nil="true"/›
                ‹con:message›
                    ‹con:messageType›FAILURE‹/con:messageType›
                    ‹con:messageDetail›No data available for given input parameters‹/con:messageDetail›
                ‹/con:message›
            ‹/con:ContractCoverageResponse›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›
                 

Back to Top / Back Home