PSS API Developer's Guide

FN Service

The FNService has two API calls associated to this service:

getFN
getFNDetails

getFN

This API service call gets all Field Notices for the specified customer, inventory and devices.

The input data (customer ID, inventory ID, and device ID) were obtained from the data returned in the first two Inventory API service calls (for more information see the "Manual Process Overview for API Service Calls" section).

It is recommended to use deviceIds as a parameter for request.

Request Parameter(s)

Parameter	Required	Type	Description
customerId	Yes	string	This parameter is returned in the API service call getCustomersInventoryIds. customerId is the ID of the Entitlement Company.
inventoryId	Yes	string	This parameter was returned in the API service call getCustomersInventoryIds. inventoryId identifies the inventory whose data will be accessed for the chassis & card level details.
deviceIds	Optional	string	The deviceIds input can be zero or more. When not providing the deviceIds, the api will return a full collection of data for that given InventoryID, for that given CustomerId, of that given PartyGUID; all the devices collected for that inventory will be returned.

Response Parameter(s)

Parameter	Type	Length	Description
deviceId	string	22	ID of the device.
fnId	string	22	Id of the field notice.
matchConfidence	string	20	Match confidence factor for the field notice item.
matchReason	string	NA*	Match reason factor for the field notice item.

responseTimestamp

Parameter	Type	Length	Description
	date	DATE	The time stamp indicates when this service call was performed.

message[ ]

Parameter	Type	Length	Description
			See Message Format section for more details.
messageType	string	255
messageDetail	string	255

*NA = Not available

SOAP Request


    POST https://api.cisco.com/pss/v1.0/FNAlertService HTTP/1.1
    Accept-Encoding: gzip,deflate
    Content-Type: text/xml;charset=UTF-8
    SOAPAction: "getFN"
    Authorization: Bearer pmx57ukvwwfwswff2c2fweer
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:fnal="http://www.cisco.com/FNAlertService"›
        ‹soapenv:Header/›
        ‹soapenv:Body›
            ‹fnal:FNRequestInput›
                ‹fnal:customerId›109757‹/fnal:customerId›
                ‹fnal:inventoryId›15224‹/fnal:inventoryId›
                ‹!--Zero or more repetitions:--›
                ‹fnal:deviceIds›‹/fnal:deviceIds›
            ‹/fnal:FNRequestInput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

SOAP Response


    HTTP/1.1 200 OK
    Date: Tue, 02 Apr 2013 20:25:55 GMT
    Server: IBM_HTTP_Server
    X-Mashery-Responder: APIX-PROD-02
    Cache-Control: private
    Pragma: private
    Content-Type: text/xml; charset=UTF-8
    Content-Language: en-US
    Cache-Control: max-age=0
    Expires: Tue, 02 Apr 2013 20:25:55 GMT
    Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
    Connection: close
    Transfer-Encoding: chunked
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
        ‹soapenv:Body›
            ‹fn:FNResponseOutput 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" 
            xmlns:con="http://www.cisco.com/ContractService"›
                ‹fn:DeviceFNResponseDTO›
                    ‹fn:deviceId›3740233‹/fn:deviceId›
                    ‹fn:deviceFN›
                        ‹fn:fnId›63315‹/fn:fnId›
                        ‹fn:matchConfidence›Not vulnerable‹/fn:matchConfidence›
                    ‹/fn:deviceFN›
                ‹/fn:DeviceFNResponseDTO›
                ‹fn:DeviceFNResponseDTO›
                    ‹fn:deviceId›3740236‹/fn:deviceId›
                    ‹fn:deviceFN›
                        ‹fn:fnId›26454‹/fn:fnId›
                        ‹fn:matchConfidence›Not vulnerable‹/fn:matchConfidence›
                    ‹/fn:deviceFN›
                ‹/fn:DeviceFNResponseDTO›
                ‹fn:DeviceFNResponseDTO›
                    ‹fn:deviceId›3740242‹/fn:deviceId›
                    ‹fn:deviceFN›
                        ‹fn:fnId›62573‹/fn:fnId›
                        ‹fn:matchConfidence›Not vulnerable‹/fn:matchConfidence›
                    ‹/fn:deviceFN›
                    ‹fn:deviceFN›
                        ‹fn:fnId›61869‹/fn:fnId›
                        ‹fn:matchConfidence›Vulnerable‹/fn:matchConfidence›
                    ‹/fn:deviceFN›
                ‹/fn:DeviceFNResponseDTO›
    ...
    ‹fn:responseTimestamp›2013-04-02T13:25:55.460-07:00‹/fn:responseTimestamp›
                ‹fn:message›
                    ‹fn:messageType›SUCCESS‹/fn:messageType›
                    ‹fn:messageDetail›Successfully got the alerts ids‹/fn:messageDetail›
                ‹/fn:message›
            ‹/fn:FNResponseOutput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

getFNDetails

This API call fetches details about specified Field Notices.

Request Parameter(s)

Parameter	Required	Type	Description
fnIds	Yes	string	Gets the details of the field notice.

Response Parameter(s)

Parameter	Type	Length	Description
fnId	string	22	Id of the field notice.
caveat	string	0	Caveat of the field notice.
distributionCode	string	0	Distribution code for the field notice.
fieldNoticeName	string	250	Name of the field notice.
fieldNoticeTypeCode	string	0	Type of code for the field notice.
fieldNoticeURL	string	4000	URL for the field notice.
firstPublishDate	date	DATE	Date the field notice was first published.
isSerialNumberAvailableCode	string	0	The available serial number codes for the field notice.
lastRevisionDate	date	DATE	Date the field notice was last revised.
publishUserId	string	0	User id of the person who published the field notice.
status	string	10	Current status of the field notice.

*Length of 0 = Not available

responseTimestamp

Parameter	Type	Length	Description
	date	DATE	The time stamp indicates when this service call was performed.

message[ ]

Parameter	Type	Length	Description
			See Message Format section for more details.
messageType	string	255
messageDetail	string	255

SOAP Request


    POST https://api.cisco.com/pss/v1.0/FNAlertService HTTP/1.1
    Accept-Encoding: gzip,deflate
    Content-Type: text/xml;charset=UTF-8
    SOAPAction: "getFNDetails"
    Authorization: Bearer pmx57ukvwwfwswff2c2fweer
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:fnal="http://www.cisco.com/FNAlertService"›
        ‹soapenv:Header/›
        ‹soapenv:Body›
            ‹fnal:FNDetailsRequestInput›
                ‹fnal:fnIds›
                    ‹!--1 or more repetitions:--›
                    ‹fnal:fnId›63315‹/fnal:fnId›
                ‹/fnal:fnIds›
            ‹/fnal:FNDetailsRequestInput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

SOAP Response


    HTTP/1.1 200 OK
    Date: Tue, 02 Apr 2013 20:40:23 GMT
    Server: IBM_HTTP_Server
    X-Mashery-Responder: APIX-PROD-02
    Cache-Control: private
    Pragma: private
    Content-Type: text/xml; charset=UTF-8
    Content-Language: en-US
    Cache-Control: max-age=0
    Expires: Tue, 02 Apr 2013 20:40:23 GMT
    Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
    Set-Cookie: ObSSOCookie=kBRjn74CotOTttXprkPIjYL%2FosSmjJndYWsi3rPcpV8j%2BWSJsln%2BNkMUn7AfYED9fc8ZDXzbzNNoD7Gmc1xn95uMcP0Gq9Y68vzssjaI6VKwM01exULOQ8%2B3ZxvI5L%2FXa%2Bix9B9b7ghDfAnxlDAIfGfDIdsRlZ0gtF4AcHlT3uiFmIjkJGIwaAv89nla91MMshP3WliAjmMPexUVSZwt93dQ30DKg19ZTuUHjPPiNUpI7geju2kPzkt4eaveJdjzjPwY4i4JaYLGJc86ZtUw6ep7nW%2Fpe%2BPEl%2BKnOd%2BSnt7qd31qTly5QJhpQgqIqqrxXrG1lyoxsskJ3zNw6A8DNlG2iLhT%2F%2BlESJUtKm%2FcEAJilCnx1P%2FnPyODBgjjqOVe; path=/; domain=.cisco.com;
    Connection: close
    Transfer-Encoding: chunked
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
        ‹soapenv:Body›
            ‹fn:FNDetailsResponseOutput 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" 
            xmlns:con="http://www.cisco.com/ContractService"›
                ‹fn:FNDetailsDTO›
                    ‹fn:fnId›63315‹/fn:fnId›
                    ‹fn:fieldNoticeName›FN#63315 - CP-79XX IP Phones, Front Label May Fall off After a Given Period of Time‹/fn:fieldNoticeName›
        ‹fn:fieldNoticeURL›http://www.cisco.com/en/US/ts/fn/633/fn63315.html‹/fn:fieldNoticeURL›
                    ‹fn:firstPublishDate›2010-04-23T00:00:00.000‹/fn:firstPublishDate›
                    ‹fn:lastRevisionDate›2010-04-22T00:00:00.000‹/fn:lastRevisionDate›
                    ‹fn:status›ACTIVE‹/fn:status›
                ‹/fn:FNDetailsDTO›
                ‹fn:responseTimestamp›2013-04-02T13:40:23.208-07:00‹/fn:responseTimestamp›
                ‹fn:message›
                    ‹fn:messageType›SUCCESS‹/fn:messageType›
                    ‹fn:messageDetail›Successfully got the alert details‹/fn:messageDetail›
                ‹/fn:message›
            ‹/fn:FNDetailsResponseOutput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

PSS API Services - FN Service

FN Service

getFN

Request Parameter(s)

Response Parameter(s)

SOAP Request

SOAP Response

getFNDetails

Request Parameter(s)

Response Parameter(s)

SOAP Request

SOAP Response