The SWEoxService has two API calls associated to this service:
This API call fetches software end-of-life id and product id information.
The input data for the Customer ID and Inventory ID is obtained from the data returned in first Inventory API call. It is recommended to use deviceId as a parameter for request.
| Parameter | Required | Type | Description |
|---|---|---|---|
| customerID | Yes | string | Customer Id is the ID of the Entitlement Company, which is returned in the API service call getCustomersInventoryIds. |
| inventoryId | Yes | string | Is a unique name that 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. |
| Parameter | Type | Length | Description |
|---|---|---|---|
| deviceId | string | 22 | Device id of the device. |
| softwareEoXId | string | 22 | Software end-of-life id. |
| softwareVersion | string | 0 | Software version number. |
| softwareType | string | 0 | Indicates the type of software. |
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 |
POST https://api.cisco.com/pss/v1.0/SwEoxAlertService HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "getSwEox"
Authorization: Bearer vmqx7u3qky4ksdyb72vgfxvg
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:swe="http://www.cisco.com/SwEoxAlertService"›
‹soapenv:Header/›
‹soapenv:Body›
‹swe:SwEoxRequestInput›
‹swe:customerId›109757‹/swe:customerId›
‹swe:inventoryId›22235‹/swe:inventoryId›
‹!--Zero or more repetitions:--›
‹swe:deviceIds›‹/swe:deviceIds›
‹/swe:SwEoxRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
HTTP/1.1 200 OK
Date: Tue, 02 Apr 2013 20:14:19 GMT
Server: IBM_HTTP_Server
X-Mashery-Responder: APIX-PROD-03
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:14:19 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›
‹sweox:SwEoxResponseOutput xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:inv="http://www.cisco.com/InventoryService"
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"›
‹sweox:DeviceSwEoxResponseDTO›
‹sweox:deviceId›3625620‹/sweox:deviceId›
‹sweox:deviceSwEox›
‹sweox:softwareEoxId›216‹/sweox:softwareEoxId›
‹sweox:softwareVersion/›
‹sweox:softwareType/›
‹/sweox:deviceSwEox›
‹/sweox:DeviceSwEoxResponseDTO›
‹sweox:deviceId›3625622‹/sweox:deviceId›
‹sweox:deviceSwEox›
‹sweox:softwareEoxId›248‹/sweox:softwareEoxId›
‹sweox:softwareVersion/›
‹sweox:softwareType/›
‹/sweox:deviceSwEox›
‹/sweox:DeviceSwEoxResponseDTO›
‹sweox:responseTimestamp›2013-04-02T13:14:19.176-07:00‹/sweox:responseTimestamp›
‹sweox:message›
‹sweox:messageType›SUCCESS‹/sweox:messageType›
‹sweox:messageDetail›Successfully got the alerts ids‹/sweox:messageDetail›
‹/sweox:message›
‹/sweox:SwEoxResponseOutput›
‹/soapenv:Body›
‹/soapenv:Envelope›
This API call fetches various software end-of-life bulletins information.
| Parameter | Required | Type | Description |
|---|---|---|---|
| softwareEoxId | Yes | string | Was obtained from the getSoftwareEox API service call. |
| Parameter | Type | Length | Description |
|---|---|---|---|
| bulletinNumber | string | 0* | Software end-of-life bulletin number. |
| bulletinURL | string | 4000 | URL for the end-of-life bulletin. |
| endOfEngineeringDate | date | DATE | Indicates the End-of-Engineering (EOE) Date, if reached, otherwise the date is blank. |
| endOfLifeDate | date | DATE | Indicates the End-of-Life (EOL) Date, if reached, otherwise the date is blank. This is the date the document announces the end of sale, and the end of life of a product is distributed to the general public. |
| endOfSaleDate | date | 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. |
| softwareEoXId | string | 22 | Id of the software slated for end of life. |
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 |
POST https://api.cisco.com/pss/v1.0/SwEoxAlertService HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "getSwEoxBulletin"
Authorization: Bearer vmqx7u3qky4ksdyb72vgfxvg
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:swe="http://www.cisco.com/SwEoxAlertService"›
‹soapenv:Header/›
‹soapenv:Body›
‹swe:SwEoxBulletinRequestInput›
‹swe:softwareEoxIds›
‹!--1 or more repetitions:--›
‹swe:softwareEoxId›216‹/swe:softwareEoxId›
‹/swe:softwareEoxIds›
‹/swe:SwEoxBulletinRequestInput›
‹/soapenv:Body›
‹/soapenv:Envelope›
HTTP/1.1 200 OK
Date: Tue, 02 Apr 2013 20:16:25 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:16:25 GMT
Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
Set-Cookie: ObSSOCookie=ohJQFlUmvsfx7XpO4Avt52RaSCzWLEeAE35gtuy2l5ByfWJwvXkcj%2BA8c3gDRgLjp2Cz99nSUcnRVSqrNHROEdWb5U%2BBrkHzjV1d8of%2F%2FC4V%2BMLnHRiP5eqjJ9qllqLugJW5J7J2HLQ3l%2BGGJLnZ2b30tCPtgjE23j7onqiW3xN5uueKDXbCjnxxdblzeClKKErRb8IBrMS37j633ycHyKVJ5lLfkWPTurDThIvOhduApfaSxvonnn9HIvjCE0%2FBDNJV4iPNcuD%2FKiTmjagVaE%2F7go081ar3N9iUSWsRpLs6dXndbCXakaR7D70ZYLICfPOc%2FbD4UW7GTMsNZu2a9gHiYZmNipxcBAwNcYmWIVv87e17d82oQQ7Px5IoIqcS; path=/; domain=.cisco.com;
Connection: close
Transfer-Encoding: chunked
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹sweox:SwEoxBulletinResponseOutput
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:inv="http://www.cisco.com/InventoryService"
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"›
‹sweox:SwEoxBulletinDTO›
‹sweox:bulletinNumber/›
‹sweox:bulletinURL›http://www.cisco.com/en/US/prod/collateral/switches/ps5718/ps4324/eol_c51_593690.html‹/sweox:bulletinURL›
‹sweox:endOfEngineeringDate›2011-08-30T00:00:00.000‹/sweox:endOfEngineeringDate›
‹sweox:endOfLifeDate›2015-09-30T00:00:00.000‹/sweox:endOfLifeDate›
‹sweox:endOfSaleDate›2010-09-20T00:00:00.000‹/sweox:endOfSaleDate›
‹sweox:softwareEoXId›216‹/sweox:softwareEoXId›
‹/sweox:SwEoxBulletinDTO›
‹sweox:responseTimestamp›2013-04-02T13:16:26.031-07:00‹/sweox:responseTimestamp›
‹sweox:message›
‹sweox:messageType›SUCCESS‹/sweox:messageType›
‹sweox:messageDetail›Successfully got the alert details‹/sweox:messageDetail›
‹/sweox:message›
‹/sweox:SwEoxBulletinResponseOutput›
‹/soapenv:Body›
‹/soapenv:Envelope›
©2016 Cisco Systems, Inc. · All Rights Reserved · This site is Cisco Confidential. For Cisco Field and Channel Partner use only. Not for public distribution.