PSS API Services - HWEox Service

HWEox Service

The HWEoxService has three API calls associated to this service:

getHwEox

This API call returns the hardware end-of-life id and product id information.

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 Is a customer Id, which is the ID of the Entitlement Company.
inventoryId Yes string Inventory Id is a unique inventory name for an upload instance.
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 Specific device id, selected from the previous API call.
hwEoxId string 22 Hardware end-of-life id and can have any number of parameters listed in the API service call.
productId string 255 Product id and can have any number of parameters listed in the API service call.

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

Back to Top / Back Home


SOAP Request


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

SOAP Response


    HTTP/1.1 200 OK
    Date: Tue, 02 Apr 2013 15:13:37 GMT
    Server: IBM_HTTP_Server
    X-Mashery-Responder: APIX-PROD-04
    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 15:13:37 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›
            ‹hweox:HwEoxResponseOutput xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
            xmlns:fn="http://www.cisco.com/FNAlertService" 
            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"›
                ‹hweox:DeviceHwEoxResponseDTO›
                    ‹hweox:deviceId›3740236‹/hweox:deviceId›
                    ‹hweox:deviceHwEox›
                        ‹hweox:hwEoxId›78062‹/hweox:hwEoxId›
                        ‹hweox:productId›WS-6509-EXL-FWM-K9‹/hweox:productId›
                    ‹/hweox:deviceHwEox›
                ‹/hweox:DeviceHwEoxResponseDTO›

    ‹hweox:responseTimestamp›2013-04-02T08:13:37.399-07:00‹/hweox:responseTimestamp›
                ‹hweox:message›
                    ‹hweox:messageType›SUCCESS‹/hweox:messageType›
                    ‹hweox:messageDetail›Successfully got the alerts ids‹/hweox:messageDetail›
                ‹/hweox:message›
                ‹/hweox:HwEoxResponseOutput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

Back to Top / Back Home


getHwEoxBulletin

This API call fetches descriptive details for the given HWEoxId(s).

Request Parameter(s)

Parameter Required Type Description
hwEoxIds Yes string Is the hardware end-of-life id and can have any number of parameters listed in the API service call.


Response Parameter(s)

Parameter Type Length Description
bulletinName string 1000 Name of the hardware bulletin.
bulletinNumber string 24 Number of the hardware bulletin.
bulletinPId string 100 Product id of the hardware bulletin.
bulletinURL string 4000 URL of the hardware bulletin.
endOfHardwareRoutineFailureAnalysisDate date DATE Indicates the End of Routine Failure Analysis Date, which is the last-possible date a routine failure analysis may be performed to determine the cause of product failure or defect.
endOfHardwareServiceContractRenewalDate date DATE Indicates the End of Service Contract Renewal (EoSCR). This the last date to extend or renew a service contract for the product. The extension or renewal period may not extend beyond the last date of support.
endOfLastDateOfSupport string DATE Indicates the End-of-Last Date of Support for the device, which is the last date to receive service and support for the product. After this date, all support services for the product are unavailable, and the product becomes obsolete.
endOfLifeExternalAnnouncementDate date DATE Indicates the End-of-Life Announcement Date, which is the date the document announces the end of sale, and end of life of a product that is distributed to the general public.
endOfSaleDate date DATE Indicates the End-of-Sale Date, which is the last date to order the product through Cisco point-of-sale mechanisms. The product is no longer for sale after this date.
endOfSoftwareMaintenanceReleasesDate date DATE Indicates the End of Software Maintenance Date, which is the last date that Cisco Engineering may release any final software maintenance releases or bug fixes. After this date, Cisco Engineering will no longer develop, repair, maintain, or test the product software.
hwEoXId string 22 Hardware end-of-life id obtained from the previous API call.
svcAttachEndDate date DATE SVC attach end date.


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

Back to Top / Back Home


SOAP Request


    POST https://api.cisco.com/pss/v1.0/HwEoxAlertService HTTP/1.1
    Accept-Encoding: gzip,deflate
    Content-Type: text/xml;charset=UTF-8
    SOAPAction: "getHwEoxBulletin"
    Authorization: Bearer vmqx7u3qky4ksdyb72vgfxvg
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:hwe="http://www.cisco.com/HwEoxAlertService"›
        ‹soapenv:Header/›
        ‹soapenv:Body›
            ‹hwe:HwEoxBulletinRequestInput›
                ‹hwe:hwEoxIds›
                    ‹!--1 or more repetitions:--›
                    ‹hwe:hwEoxId›78062‹/hwe:hwEoxId›
                ‹/hwe:hwEoxIds›
            ‹/hwe:HwEoxBulletinRequestInput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

SOAP Response


    HTTP/1.1 200 OK
    Date: Tue, 02 Apr 2013 15:17:59 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 15:17:59 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›
            ‹hweox:HwEoxBulletinResponseOutput 
            xmlns:hweox="http://www.cisco.com/HwEoxAlertService" 
            xmlns:fn="http://www.cisco.com/FNAlertService" 
            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"›
                ‹hweox:HwEoxBulletinDTO›
                    ‹hweox:bulletinName›Select Cisco Catalyst 6503, 6506, and 6509 Chassis‹/hweox:bulletinName›
                    ‹hweox:bulletinNumber›3037‹/hweox:bulletinNumber›
                    ‹hweox:bulletinPID›WS-C6509‹/hweox:bulletinPID›
                    ‹hweox:bulletinURL›http://www.cisco.com/en/US/products/hw/switches/ps708/prod_eol_notice0900aecd8035ece4.html‹/hweox:bulletinURL›
                    ‹hweox:endOfHardwareRoutineFailureAnalysisDate›2007-11-01T00:00:00.000‹/hweox:endOfHardwareRoutineFailureAnalysisDate›
                    ‹hweox:endOfHardwareServiceContractRenewalDate›2012-08-01T00:00:00.000‹/hweox:endOfHardwareServiceContractRenewalDate›
                    ‹hweox:endOfLastDateOfSupport›2012-11-30T00:00:00.000‹/hweox:endOfLastDateOfSupport›
                    ‹hweox:endOfLifeExternalAnnouncementDate›2005-11-01T00:00:00.000‹/hweox:endOfLifeExternalAnnouncementDate›
                    ‹hweox:endOfSaleDate›2006-11-01T00:00:00.000‹/hweox:endOfSaleDate›
                    ‹hweox:hwEoXId›78062‹/hweox:hwEoXId›
                    ‹hweox:svcAttachEndDate›2007-11-01T00:00:00.000‹/hweox:svcAttachEndDate›
                ‹/hweox:HwEoxBulletinDTO›

            ‹hweox:responseTimestamp›2013-04-02T08:18:00.120-07:00‹/hweox:responseTimestamp›
                ‹hweox:message›
                    ‹hweox:messageType›SUCCESS‹/hweox:messageType›
                    ‹hweox:messageDetail›Successfully got the alert details‹/hweox:messageDetail›
                ‹/hweox:message›
            ‹/hweox:HwEoxBulletinResponseOutput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

Back to Top / Back Home


getHwEoxMigrationPIDs

This API call fetches a list of Customer IDs, Inventories ID, and their associated names.

Request Parameter(s)

Parameter Required Type Description
hwEoxIds Yes string Hardware end-of-life migration id's.

Response Parameter(s)

Parameter Type Length Description
pid string 100 Device's product ID.
hwEoxId string 22 Device's hardware end-of-life (EoX) id.
migrationPAICode string 25 Migration product additional information (PAI) code, or green code.
migrationPAIDesc string 500 Migration PAI Code Description.
migrationPAIText string 500 Migration PAI additional information.
migrationPID string 48 Migration product id (PID).
migrationProductDataURL string 500 Migration product data sheet url.
migrationProductModel string 640 Migration product model.
migrationProductPageURL string 500 Migration product page url.
migrationProductPaperURL string 500 Migration product white paper url.
migrationProductSeries string 640 Migration product series.
migrationPromotionText string 2000 Migration promotion information.
migrationPromotionURL string 500 URL to the migration product promotion site.

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

Back to Top / Back Home


SOAP Request


    POST https://api.cisco.com/pss/v1.0/HwEoxAlertService HTTP/1.1
    Accept-Encoding: gzip,deflate
    Content-Type: text/xml;charset=UTF-8
    SOAPAction: "getHwEoxMigrationPIDs"
    Authorization: Bearer vmqx7u3qky4ksdyb72vgfxvg
    
    ‹soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:hwe="http://www.cisco.com/HwEoxAlertService"›
        ‹soapenv:Header/›
        ‹soapenv:Body›
            ‹hwe:HwEoxMigrationPidRequestInput›
                ‹hwe:hwEoxIds›
                    ‹!--1 or more repetitions:--›
                    ‹hwe:hwEoxId›78062‹/hwe:hwEoxId›
                ‹/hwe:hwEoxIds›
            ‹/hwe:HwEoxMigrationPidRequestInput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

SOAP Response


    HTTP/1.1 200 OK
    Date: Tue, 02 Apr 2013 15:30:58 GMT
    Server: IBM_HTTP_Server
    X-Mashery-Responder: APIX-PROD-04
    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 15:30:58 GMT
    Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
    Set-Cookie: ObSSOCookie=eYmhaA48ScsQSlzQOP57WW%2Fm6AmFtWYXOig%2FTNjWRBMYBrippNGQQKh2DGJ1J3yR7Pcty2GKpkIrpzdOo2cdrAzqycx%2Fw%2FouZPwI2IkzFM6iwxwmJpI1OrZgR1mFTx4nqM7819WZInHZu%2BFvP9%2Bdtw2AxamMc6BvpB3DV0nb7b%2Fva5C4q2YMBqm4rwnBJXfGqmq%2FR0qH7BKPQyu8yTX7fzCQCEnHh5aQHbaOpEc%2FqkBipHc%2FmCnoDy16fb%2FDIg2iG89TJxvcP1DQMC2JcvTNoWzPKeyAasbhvZoXYLD8IBFnEv8WY08aLKw2mNDleiN1XTfeNczCNpiIK6S6VZWJ8I4QXZhkb9YT7YOnvQRyhX8%3D; path=/; domain=.cisco.com;
    Connection: close
    Transfer-Encoding: chunked
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
        ‹soapenv:Body›
            ‹hweox:HwEoxMigrationPidResponseOutput
            xmlns:hweox="http://www.cisco.com/HwEoxAlertService" 
            xmlns:fn="http://www.cisco.com/FNAlertService" 
            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"›
                ‹hweox:HwEoxMigrationPidDTO›
	                ‹hweox:pid›WS-C6509‹/hweox:pid›
                ‹hweox:hwEoxId›78062‹/hweox:hwEoxId›
                ‹hweox:hwEoxMigrationPid›
                    ‹hweox:migrationPAICode›Not Available‹/hweox:migrationPAICode›
                    ‹hweox:migrationPAIDesc›Not Available‹/hweox:migrationPAIDesc›
                    ‹hweox:migrationPAIText›Not Available‹/hweox:migrationPAIText›
                    ‹hweox:migrationPID›WS-C6509-E‹/hweox:migrationPID›
	‹hweox:migrationProductDataURL›http://www.cisco.com/en/US/products/hw/switches/ps708/products_data_sheets_list.html‹/hweox:migrationProductDataURL›
                    ‹hweox:migrationProductModel›Not Available‹/hweox:migrationProductModel›
                    ‹hweox:migrationProductPageURL›Not Available‹/hweox:migrationProductPageURL›
                    ‹hweox:migrationProductPaperURL›Not Available‹/hweox:migrationProductPaperURL›
                    ‹hweox:migrationProductSeries›Not Available‹/hweox:migrationProductSeries›
                    ‹hweox:migrationPromotionText›Not Available‹/hweox:migrationPromotionText›
                    ‹hweox:migrationPromotionURL›Not Available‹/hweox:migrationPromotionURL›
			‹/hweox:hwEoxMigrationPid›
		‹/hweox:HwEoxMigrationPidDTO›
                
	‹hweox:responseTimestamp›2013-04-02T08:30:59.132-07:00‹/hweox:responseTimestamp›
                ‹hweox:message›
                   ‹hweox:messageType›SUCCESS‹/hweox:messageType›
                   ‹hweox:messageDetail›Successfully got the Migration Pid Details‹/hweox:messageDetail›
                ‹/hweox:message›
            ‹/hweox:HwEoxMigrationPidResponseOutput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

Back to Top / Back Home

©2016 Cisco Systems, Inc. · All Rights Reserved · This site is Cisco Confidential. For Cisco Field and Channel Partner use only. Not for public distribution.