Introduction

Overview

The process of selecting the appropriate software upgrade path for your environment can be complex. The Cisco Software Suggestions streamline the software selection process by providing the necessary information to assist you in making intelligent choices for upgrading your software.

Features

The Cisco Software Suggestion provides the following features:

  • Delivery of composite RESTful API.
  • Supports JSON data format

API Reference

This topic describes the methods provided by this API.

Notes:

  • JSON output from the service will not include fields that are empty or that include a null value.
  • For information on error codes returned by these methods, see Error Codes.
  • You can download the WADL for this API by clicking the following link: Cisco Software Suggestion API WADL

Get Suggested Releases and Images by Product IDs

Returns a list of Cisco suggested software releases and images for a list of product IDs.

URI

https://apix.cisco.com/software/suggestion/v2/suggestions/software/productIds/{productIds}

Request Parameters

Parameter Required Type Length Description
productIds Yes string 20 Base product IDs for which to return suggested software releases. A maximum of 10 PIDs are allowed. Note: Currently, the value for basePID can be submitted without the parameter name in the request URI. For example: /suggestions/software/productIds/CISCO2811 where CISCO2811 is the basePID value.
pageIndex No int 4 Index number of the page to return.

Response Parameters

Parameter Type Description
paginationResponseRecord PaginationResponseRecordType Index number for the page requested, and the total number of pages available to return.
For more information, see PaginationResponseRecordType
productList ProductListType Product specific information for the requested PIDs.
Multiple Products for the same PID can be returned. For more information, see ProductListType
status String Service Response Status.
errorDetailsResponse ErrorDetailsType Service / Validation Error details. For more information, see ErrorDetailsType

Sample Request

GET https://apix.cisco.com/software/suggestion/v2/suggestions/software/productIds/ASR-903,CISCO2811,N7K-C7018?pageIndex=1

Sample Response

{
   "paginationResponseRecord": {
      "pageIndex": "1",
      "lastIndex": "1",
      "totalRecords": "1",
      "pageRecords": "1",
      "selfLink": "https://apix.cisco.com/software/suggestion/v2/suggestions/software/productIds/ASR-903,N7K-C7018?pageIndex=1&contentType=json",
      "title": "Software Suggestions"
   },
   "productList": [{
      "id": "1",
      "product": {
         "basePID": "ASR-903",
         "mdfId": "283795847",
         "productName": "ASR 903 Route Switch Processor 1 (RSP1)",
         "softwareType": "IOS XE Software"
      },
      "suggestions": [{
         "id": "1",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.1",
         "releaseFormat2": "16.1.1",
         "releaseDate": "24 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.1",
         "trainDispName": "Denali-16.1",
         "images": [{
            "imageName": "asr1000rpx86-universalk9.16.01.01.SPA.bin",
            "imageSize": "392744",
            "featureSet": "CCO Only",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         }],
         "errorDetailsResponse": null
      },{
         "id": "2",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.2",
         "releaseFormat2": "16.1.2",
         "releaseDate": "23 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.2",
         "trainDispName": "Denali-16.1",
         "images": [{
            "imageName": " asr1000rpx86-universalk9.16.01.02.SPA.bin",
            "imageSize": "272137",
            "featureSet": "CCO and MFG",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         },{
            "imageName": " asr1000rpx86-universal.16.01.02.SPA.bin",
            "imageSize": "113345",
            "featureSet": "CCO only",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         }],
         "errorDetailsResponse": null
      },{
         "id": "3",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.3",
         "releaseFormat2": "16.1.3",
         "releaseDate": "24 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.3",
         "trainDispName": "Denali-16.1",
         "images": [{
            "imageName": " asr1000rpx86-universalk9.16.01.03.SPA.bin",
            "imageSize": "165189",
            "featureSet": "CCO Only",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         },{
            "imageName": " asr1000rpx86-universal.16.01.03.SPA.bin",
            "imageSize": "220385",
            "featureSet": "CCO and MFG",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         }],
         "errorDetailsResponse": null
      }]
   }],
   "status": "Success",
   "errorDetailsResponse": null
}

Get Suggested Releases by Product IDs (No Images)

Returns a list of Cisco suggested software releases (without images) for a list of product IDs.

URI

https://apix.cisco.com/software/suggestion/v2/suggestions/releases/productIds/{productIds}

Request Parameters

Parameter Required Type Length Description
productIds Yes string 20 Base product IDs for which to return suggested software releases. A maximum of 10 PIDs are allowed. Note: Currently, the value for basePID can be submitted without the parameter name in the request URI. For example: /suggestions/releases/productIds/CISCO2811 where CISCO2811 is the basePID value.
pageIndex No int 4 Index number of the page to return.

Response Parameters

Parameter Type Description
paginationResponseRecord PaginationResponseRecordType Index number for the page requested, and the total number of pages available to return.
For more information, see PaginationResponseRecordType
productList ProductListType Product specific information for the requested PIDs.
Multiple Products for the same PID can be returned. For more information, see ProductListType
status String Service Response Status.
errorDetailsResponse ErrorDetailsType Service / Validation Error details. For more information, see ErrorDetailsType

Sample Request

GET https://apix.cisco.com/software/suggestion/v2/suggestions/releases/productIds/ASR-903,N7KS1K9-404,CISCO2811,ONS-GX-2FC-MMI?pageIndex=1

Sample Response

{
   "paginationResponseRecord": {
      "pageIndex": "1",
      "lastIndex": "1",
      "totalRecords": "1",
      "pageRecords": "1",
      "selfLink": "https://apix.cisco.com/software/suggestion/v2/suggestions/releases/productIds/ASR-903?",
      "title": "Software Suggestions"
   },
   "productList": [{
      "id": "1",
      "product": {
         "basePID": "ASR-903",
         "mdfId": "283795847",
         "productName": "ASR 903 Route Switch Processor 1 (RSP1)",
         "softwareType": "IOS XE Software"
      },
      "suggestions": [{
         "id": "1",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.1",
         "releaseFormat2": "16.1.1",
         "releaseDate": "24 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.1",
         "trainDispName": "Denali-16.1",
         "errorDetailsResponse": null
      },{
         "id": "2",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.2",
         "releaseFormat2": "16.1.2",
         "releaseDate": "25 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.2",
         "trainDispName": "Denali-16.1",
         "errorDetailsResponse": null
      },{
         "id": "3",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.3",
         "releaseFormat2": "16.1.3",
         "releaseDate": "27 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.3",
         "trainDispName": "Denali-16.1",
         "errorDetailsResponse": null
      }]
   }],
   "status": "Success",
   "errorDetailsResponse": null
}

GET Compatible and Suggested Software Releases by Product ID

Returns compatible and suggested software releases for a product given its product identifier (PID) and specific software attributes.

URI

https://apix.cisco.com/software/suggestion/v2/suggestions/compatible/productId/{basePID}

Request Parameters

Parameter Required Type Length Description
productId Yes string 20 Base product ID for which to return suggested software releases. A maximum of 1 PID is allowed. Note: Currently, the value for basePID can be submitted without the parameter name in the request URI. For example: /suggestions/compatible/productId/CISCO2811 where CISCO2811 is the basePID value.
currentImage No string 59 Current image identifier from which to filter the results. The request should be formatted as follows: /suggestions/compatible/productId/CISCO2811?currentImage=c2801-adventerprisek9-mz.151-4.M6.bin
currentRelease No string 15 Current release version from which to filter the results. The request should be formatted as follows:
  • /suggestions/compatible/productId/CISCO2811?currentRelease=15.0(24)T7
  • /suggestions/compatible/productId/CISCO2811?currentRelease=15.0.24T7
pageIndex No int 4 Index number of the page to return.
supportedFeatures No string 512 Comma-separated list of feature identifiers by which to filter the results. A maximum of 10 feature names are allowed; the total length of all features cannot exceed 512 characters. The request should be formatted as follows: /suggestions/compatible/productId/ASR1013?supportedFeatures=Synchronous Optical NETwork (SONET)
supportedHardware No string 25 List of supported hardware identifiers from which to filter the results; for example, HWIC-1FE, CISCO3925/K9, C3900-SPE100/K9, NM-CUE, NM-2FE2W-V2, NM-1A-T3, NM-16ESW. The request should be formatted as follows: /suggestions/compatible/productId/CISCO2811?supportedHardware=HWIC-1FE,CISCO3925/K9,C3900-SPE100/K9,NM-CUE,NM-2FE2W-V2,NM-1A-T3,NM-16ESW

Response Parameters

Parameter Type Description
paginationResponseRecord PaginationResponseRecordType Index number for the page requested, and the total number of pages available to return.
For more information, see PaginationResponseRecordType
suggestions SuggestionType Suggested Releases specific information for the requested PIDs.
Multiple suggested releases for the same PID can be returned. For more information, see SuggestionType
status String Service Response Status.
errorDetailsResponse ErrorDetailsType Service / Validation Error details. For more information, see ErrorDetailsType

Sample Request

GET https://apix.cisco.com/software/suggestion/v2/suggestions/compatible/productId/ASR1013?pageIndex=1&supportedFeatures=Synchronous Optical NETwork (SONET)

Sample Response

{
   "paginationResponseRecord": {
      "pageIndex": "1",
      "lastIndex": "1",
      "totalRecords": "1",
      "pageRecords": "1",
      "selfLink": "https://apix.cisco.com/software/suggestion/v2/suggestions/compatible/productId/ASR1013",
      "title": "Software Suggestions"
   },
   "suggestions": [{
      "id": "1",
      "isSuggested": "N",
      "basePID": "ASR1013",
      "mdfId": "283795847",
      "productName": "ASR 1013 Router",
      "softwareType": "IOS XE Software",
      "releaseFormat1": "16.1.1",
      "releaseFormat2": "16.1.1",
      "releaseDate": "02 Feb 2014",
      "majorRelease": "16",
      "releaseTrain": "16.1",
      "releaseLifeCycle": "ED",
      "relDispName": "Denali-16.1.1",
      "trainDispName": "Denali-16.1",
      "errorDetailsResponse": null,
      "images": [{
         "imageName": "asr1000rpx86-universalk9.16.01.01.SPA.bin",
         "imageSize": "529325428",
         "featureSet": null,
         "description": " ",
         "requiredDRAM": "0 MB",
         "requiredFlash": ""
      }]
   }],
   "status": "Success",
   "errorDetailsResponse": null
}

Get Suggested Releases and Images by MDF IDs

Returns a list of Cisco suggested software releases and images for a list of mdf IDs.

URI

https://apix.cisco.com/software/suggestion/v2/suggestions/software/mdfIds/{mdfIds}

Request Parameters

Parameter Required Type Length Description
mdfIds Yes string 20 Base mdf IDs for which to return suggested software releases. A maximum of 10 mdf Ids (comma separated) are allowed. Note: Currently, the value for mdfIds can be submitted with the parameter name mdfIds in the request URI. For example: /suggestions/software/mdfIds/283933147,283780951 where 283933147,283780951 are the base mdfIds value.
pageIndex No int 4 Index number of the page to return.

Response Parameters

Parameter Type Description
paginationResponseRecord PaginationResponseRecordType Index number for the page requested, and the total number of pages available to return.
For more information, see PaginationResponseRecordType
productList ProductListType Product specific information for the requested PIDs.
Multiple Products for the same PID can be returned. For more information, see ProductListType
status String Service Response Status.
errorDetailsResponse ErrorDetailsType Service / Validation Error details. For more information, see ErrorDetailsType

Sample Request

GET https://apix.cisco.com/software/suggestion/v2/suggestions/software/mdfIds/283933147,283780951?pageIndex=1

Sample Response

{
   "paginationResponseRecord": {
      "pageIndex": "1",
      "lastIndex": "1",
      "totalRecords": "1",
      "pageRecords": "1",
      "selfLink": "https://apix.cisco.com/software/suggestion/v2/suggestions/software/mdfIds/283933147,283780951?pageIndex=1&contentType=json",
      "title": "Software Suggestions"
   },
   "productList": [{
      "id": "1",
      "product": {
         "mdfId": "283795847",
         "productName": "ASR 903 Route Switch Processor 1 (RSP1)",
         "softwareType": "IOS XE Software"
      },
      "suggestions": [{
         "id": "1",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.1",
         "releaseFormat2": "16.1.1",
         "releaseDate": "24 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.1",
         "trainDispName": "Denali-16.1",
         "images": [{
            "imageName": "asr1000rpx86-universalk9.16.01.01.SPA.bin",
            "imageSize": "392744",
            "featureSet": "CCO Only",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         }],
         "errorDetailsResponse": null
      },{
         "id": "2",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.2",
         "releaseFormat2": "16.1.2",
         "releaseDate": "23 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.2",
         "trainDispName": "Denali-16.1",
         "images": [{
            "imageName": " asr1000rpx86-universalk9.16.01.02.SPA.bin",
            "imageSize": "272137",
            "featureSet": "CCO and MFG",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         },{
            "imageName": " asr1000rpx86-universal.16.01.02.SPA.bin",
            "imageSize": "113345",
            "featureSet": "CCO only",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         }],
         "errorDetailsResponse": null
      },{
         "id": "3",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.3",
         "releaseFormat2": "16.1.3",
         "releaseDate": "24 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.3",
         "trainDispName": "Denali-16.1",
         "images": [{
            "imageName": " asr1000rpx86-universalk9.16.01.03.SPA.bin",
            "imageSize": "165189",
            "featureSet": "CCO Only",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         },{
            "imageName": " asr1000rpx86-universal.16.01.03.SPA.bin",
            "imageSize": "220385",
            "featureSet": "CCO and MFG",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         }],
         "errorDetailsResponse": null
      }]
   }, {
      "id": "2",
      "product": {
         "mdfId": "283780951",
         "productName": "ASR 903 Route",
         "softwareType": "IOS XE Software"
      },
      "suggestions": [{
         "id": "1",
         "isSuggested": "Y",
         "releaseFormat1": "3.16.5S",
         "releaseFormat2": "3.16.5S",
         "releaseDate": "24 May 2016",
         "majorRelease": "3",
         "releaseTrain": "1.16",
         "releaseLifeCycle": "MD",
         "relDispName": "3.16.5S",
         "trainDispName": "3.16S",
         "images": [{
            "imageName": "asr1000rpx86-universalk9.16.01.01.SPA.bin",
            "imageSize": "392744",
            "featureSet": "CCO Only",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         }],
         "errorDetailsResponse": null
      },{
         "id": "2",
         "isSuggested": "Y",
         "releaseFormat1": "3.13.7S",
         "releaseFormat2": "3.13.7S",
         "releaseDate": "23 May 2016",
         "majorRelease": "3",
         "releaseTrain": "3.13",
         "releaseLifeCycle": "MD",
         "relDispName": "3.13.7S",
         "trainDispName": "3.13S",
         "images": [{
            "imageName": " asr1000rpx86-universalk9.16.01.02.SPA.bin",
            "imageSize": "272137",
            "featureSet": "CCO and MFG",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         },{
            "imageName": " asr1000rpx86-universal.16.01.02.SPA.bin",
            "imageSize": "113345",
            "featureSet": "CCO only",
            "description": " ",
            "requiredDRAM": "0 MB",
            "requiredFlash": " MB"
         }],
         "errorDetailsResponse": null
      }]}],
   "status": "Success",
   "errorDetailsResponse": null
}

Get Suggested Releases by MDF IDs (No Images)

Returns a list of Cisco suggested software releases (without images) for a list of mdf IDs.

URI

https://apix.cisco.com/software/suggestion/v2/suggestions/releases/mdfIds/{mdfIds}

Request Parameters

Parameter Required Type Length Description
mdfIds Yes string 20 Base mdf IDs for which to return suggested software releases. A maximum of 10 mdf Ids (comma separated) are allowed. Note: Currently, the value for mdfIds can be submitted with the parameter name mdfIds in the request URI. For example: /suggestions/releases/mdfIds/283933147,283780951 where 283933147,283780951 are the base mdfIds value.
pageIndex No int 4 Index number of the page to return.

Response Parameters

Parameter Type Description
paginationResponseRecord PaginationResponseRecordType Index number for the page requested, and the total number of pages available to return.
For more information, see PaginationResponseRecordType
productList ProductListType Product specific information for the requested PIDs.
Multiple Products for the same PID can be returned. For more information, see ProductListType
status String Service Response Status.
errorDetailsResponse ErrorDetailsType Service / Validation Error details. For more information, see ErrorDetailsType

Sample Request

GET https://apix.cisco.com/software/suggestion/v2/suggestions/releases/mdfIds/283933147,283780951?pageIndex=1

Sample Response

{
   "paginationResponseRecord": {
      "pageIndex": "1",
      "lastIndex": "1",
      "totalRecords": "1",
      "pageRecords": "1",
      "selfLink": "https://apix.cisco.com/software/suggestion/v2/suggestions/releases/mdfIds/283933147,283780951?pageIndex=1&contentType=json",
      "title": "Software Suggestions"
   },
   "productList": [{
      "id": "1",
      "product": {
         "mdfId": "283795847",
         "productName": "ASR 903 Route Switch Processor 1 (RSP1)",
         "softwareType": "IOS XE Software"
      },
      "suggestions": [{
         "id": "1",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.1",
         "releaseFormat2": "16.1.1",
         "releaseDate": "24 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.1",
         "trainDispName": "Denali-16.1",
         "errorDetailsResponse": null
      },{
         "id": "2",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.2",
         "releaseFormat2": "16.1.2",
         "releaseDate": "23 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.2",
         "trainDispName": "Denali-16.1",
         "errorDetailsResponse": null
      },{
         "id": "3",
         "isSuggested": "Y",
         "releaseFormat1": "16.1.3",
         "releaseFormat2": "16.1.3",
         "releaseDate": "24 May 2016",
         "majorRelease": "16",
         "releaseTrain": "16.1",
         "releaseLifeCycle": "MD",
         "relDispName": "Denali-16.1.3",
         "trainDispName": "Denali-16.1",
         "errorDetailsResponse": null
      }]
   }, {
      "id": "2",
      "product": {
         "mdfId": "283780951",
         "productName": "ASR 903 Route",
         "softwareType": "IOS XE Software"
      },
      "suggestions": [{
         "id": "1",
         "isSuggested": "Y",
         "releaseFormat1": "3.16.5S",
         "releaseFormat2": "3.16.5S",
         "releaseDate": "24 May 2016",
         "majorRelease": "3",
         "releaseTrain": "1.16",
         "releaseLifeCycle": "MD",
         "relDispName": "3.16.5S",
         "trainDispName": "3.16S",
         "errorDetailsResponse": null
      },{
         "id": "2",
         "isSuggested": "Y",
         "releaseFormat1": "3.13.7S",
         "releaseFormat2": "3.13.7S",
         "releaseDate": "23 May 2016",
         "majorRelease": "3",
         "releaseTrain": "3.13",
         "releaseLifeCycle": "MD",
         "relDispName": "3.13.7S",
         "trainDispName": "3.13S",
         "errorDetailsResponse": null
      }]}],
   "status": "Success",
   "errorDetailsResponse": null
}

GET Compatible and Suggested Software Releases by MDF ID

Returns compatible and suggested software releases for a product given its mdf identifier (mdfId) and specific software attributes.

URI

https://apix.cisco.com/software/suggestion/v2/suggestions/compatible/mdfId/{mdfId}

Request Parameters

Parameter Required Type Length Description
mdfId Yes string 20 Base mdf ID for which to return suggested software releases. A maximum of 1 mdfId are allowed. Note: Currently, the value for base mdfId can be submitted with the parameter name mdfId in the request URI. For example: /suggestions/compatible/mdfId/283795847 where 283795847 is the baseMdfId value.
currentImage No string 59 Current image identifier from which to filter the results. The request should be formatted as follows: /suggestions/compatible/mdfId/283795847?currentImage=c2801-adventerprisek9-mz.151-4.M6.bin
currentRelease No string 15 Current release version from which to filter the results. The request should be formatted as follows:
  • /suggestions/compatible/mdfId/283795847?currentRelease=15.0(24)T7
  • /suggestions/compatible/mdfId/283795847?currentRelease=15.0.24T7
pageIndex No int 4 Index number of the page to return.
supportedFeatures No string 512 Comma-separated list of feature identifiers by which to filter the results. A maximum of 10 feature names are allowed; the total length of all features cannot exceed 512 characters. The request should be formatted as follows: /suggestions/compatible/mdfId/283795847?supportedFeatures=Synchronous Optical NETwork (SONET)
supportedHardware No string 25 List of supported hardware identifiers from which to filter the results; for example, HWIC-1FE, CISCO3925/K9, C3900-SPE100/K9, NM-CUE, NM-2FE2W-V2, NM-1A-T3, NM-16ESW. The request should be formatted as follows: /suggestions/compatible/mdfId/283795847?supportedHardware=HWIC-1FE,CISCO3925/K9,C3900-SPE100/K9,NM-CUE,NM-2FE2W-V2,NM-1A-T3,NM-16ESW

Response Parameters

Parameter Type Description
paginationResponseRecord PaginationResponseRecordType Index number for the page requested, and the total number of pages available to return.
For more information, see PaginationResponseRecordType
suggestions SuggestionType Suggested Releases specific information for the requested PIDs.
Multiple suggested releases for the same PID can be returned. For more information, see SuggestionType
status String Service Response Status.
errorDetailsResponse ErrorDetailsType Service / Validation Error details. For more information, see ErrorDetailsType

Sample Request

GET https://apix.cisco.com/software/suggestion/v2/suggestions/compatible/mdfId/283795847?pageIndex=1&supportedFeatures=Synchronous Optical NETwork (SONET)

Sample Response

{
   "paginationResponseRecord": {
      "pageIndex": "1",
      "lastIndex": "1",
      "totalRecords": "1",
      "pageRecords": "1",
      "selfLink": "https://apix.cisco.com/software/suggestion/v2/suggestions/compatible/mdfId/283795847",
      "title": "Software Suggestions"
   },
   "suggestions": [{
      "id": "1",
      "isSuggested": "N",
      "mdfId": "283795847",
      "productName": "ASR 1013 Router",
      "softwareType": "IOS XE Software",
      "releaseFormat1": "16.1.1",
      "releaseFormat2": "16.1.1",
      "releaseDate": "02 Feb 2014",
      "majorRelease": "16",
      "releaseTrain": "16.1",
      "releaseLifeCycle": "ED",
      "relDispName": "Denali-16.1.1",
      "trainDispName": "Denali-16.1",
      "errorDetailsResponse": null,
      "images": [{
         "imageName": "asr1000rpx86-universalk9.16.01.01.SPA.bin",
         "imageSize": "529325428",
         "featureSet": null,
         "description": " ",
         "requiredDRAM": "0 MB",
         "requiredFlash": ""
      }]
   }]
   "status": "Success",
   "errorDetailsResponse": null
}

Request and Response Parameters

This topic describes the following Cisco Suggestion API request and response parameters:

Request Parameters

This topic describes the following Cisco Suggestion API request parameters:

Response Parameters

This topic describes the following Cisco Suggestion API response parameters:

PaginationResponseRecordType

Provides information about the page requested and the total number of pages available to return.

Parameters

Parameter Type Description
pageIndex integer Index number of the requested page.
lastIndex integer Total number of pages available.
totalRecords integer Total results for this query.
pageRecords integer Total results for this page.
selfLink String WebService Self Link.
title String Api Title.

Sample JSON Response

"paginationResponseRecord": {
        "pageIndex": "1",
        "lastIndex": "1",
        "totalRecords": "4",
        "pageRecords": "4",
        "selfLink": "https://api-stage.cisco.com/software/suggestion/v2/suggestions/software/productIds/CISCO1841",
        "title": "Software Suggestions"
    }

ErrorDetailsType

Provides information about errors that occur during an operation. For more information on error codes, see Error Codes.

Parameters

Parameter Type Description
errorCode string Identification number associated with the error message.
errorDescription string Description of the error message.
suggestedAction string Suggested Action
  • Supply Valid input parameters
  • Supply Valid basePID
  • Please provide basePID that is supported
  • Please provide a basePID in the url
  • Please refer S3 API user guide for valid parameter names & values
  • Please provide proper current release
  • Please provide valid numeric values (1 <= pageIndex <= lastIndex ) for pageIndex
  • We support only json response. Please provide contentType as json/JSON
  • Activate Hardware Supported Filtering
  • Please enter valid input
  • Please provide upto 10 or less basePids in the request
  • Please enter valid numeric mdfId
  • Please provide a mdfId in the url
  • Please provide mdfId that is supported
  • Please provide upto 10 or less mdfIds in the request
inputIdentifier string Describes the inputIdentifier, either product identified - PID(s) or mdf identifier - mdfId(s).

Sample JSON Response

"errorDetailsResponse": {
        "errorCode": "S3_INV_QUERY_PARAM",
        "errorDescription": "Invalid query parameters in url",
        "suggestedAction": "Please provide valid numeric values (1 <= pageIndex <= lastIndex ) for pageIndex",
        "inputIdentifier": "CISCO2811"
    }

SuggestionType

Provides information about suggested releases for a request.

Parameters

Parameter Type Description
id integer Identifier of the record in the result set.
isSuggested string Indicates whether this release is Cisco Suggested; one of the following values:
  • Y (Yes)
  • N (No)
basePID string Base product identifier of the device; for example, manufacturing or chassis product ID.
mdfId string Base mdf identifier of the product i.e. Id of the device from the Cisco Metadata Framework (MDF).
productName string Name of the device from the Cisco Metadata Framework (MDF).
softwareType string Type of a software for given product; for example, IOS Software.
releaseFormat1 string Release version of the software; for example, 15.1.4M5.
releaseFormat2 string Release version of the software; for example, 15.1(4)M5.
releaseDate string Release date of the software; for example, 17 Nov 2014.
majorRelease string Major release version.
releaseTrain string Release train for the given software. All compatible release trains are included in the response.
releaseLifeCycle string Release lifecycle of the software.
relDispName String Release version of the software with brand name; for example, Denali-16.1.1.
trainDispName String Release version of the software with brand name; for example, Denali-16.1.1.
images ImagesType Image details. For more information, see ImagesType
errorDetailsResponse ErrorDetailsType Error details. For more information, see ErrorDetailsType

ImagesType

Provides information about images for the suggested releases.

Parameters

Parameter Type Description
imageName string Name of the image/release.
imageSize integer Total size (in bytes) of the image/release.
featureSet integer Feature Set image is associated with.
description integer Image descriptiion.
requiredDRAM integer RAM required for the software version to be downloaded onto the appliance.
requiredFlash integer Memory required for downloading the software.
The memory is displayed in the unit along with the value.

Sample JSON Response

"images": [{
		"imageName": "c3900e-universalk9_npe-mz.SPA.156-2.T.bin",
		"imageSize": "109700216",
		"featureSet": "UNIVERSAL - NO PAYLOAD ENCRYPTION",
		"description": " ",
		"requiredDRAM": "1024 MB",
		"requiredFlash": "256 MB"
	},
	{
		"imageName": "c800-universalk9-mz.SPA.156-2.T.bin",
		"imageSize": "89977880",
		"featureSet": "UNIVERSAL",
		"description": " ",
		"requiredDRAM": "512 MB",
		"requiredFlash": "512 MB"
	}
]

ProductType

Provides information about the ProductType.

Parameters

Parameter Type Description
basePID string Base product identifier of the device; for example, manufacturing or chassis product ID.
mdfId string Base mdf identifier of the product i.e. Id of the device from the Cisco Metadata Framework (MDF).
productName string Name of the device from the Cisco Metadata Framework (MDF).
softwareType string Type of a software for given product; for example, IOS Software.

NOTE: basePID is not applicable in response for mdfId variants.

Sample JSON Response

"product": {
		"basePID": "CISCO2811",
		"mdfId": "279042634",
		"productName": "3845 Integrated Services Router",
		"softwareType": "IOS Software"
	}

ProductListType

Provides information about the ProductType List.

Parameters

Parameter Type Description
id String Index number of the productType object.
product ProductType ProductType object, For more information on ProductType, see ProductType
suggestions SuggestionType List of SuggestionType, see SuggestionType

Error Codes

This table describes the error codes returned by the Cisco Software Suggestion.

Generic HTTP Status Codes

HTTP Status Code Message Description
403 Forbidden You have not been granted permission to access the requested method or object.
403 ERR_403_NOT_AUTHORIZED The API key associated with your request was not recognized or the signature was incorrect.
403 ERR_403_DEVELOPER_INACTIVE The API key you are using to access the APIx proxy has not been approved or has been disabled.
403 ERR_403_DEVELOPER_OVER_QPS Account Over Queries Per Second Limit. The API key you are using has attempted to access the API too many times in one second.
403 ERR_403_DEVELOPER_OVER_RATE The API key you are using has attempted to access the API too many times in the rate limiting period (1 day).
403 Rate Limit Exceeded The service you have requested is over capacity.

Application-Specific Error Codes

This table describes the application specific error codes returned by the S3 suggestion API.

Error Code Message Suggestion
S3_BASEPID_NO_SUPPORT This basePID is currently not supported Please provide basePID that is supported
S3_BASEPID_REQ BasePID is a mandatory field Please provide a basePID in the url
S3_HW_INFORMATION_NOT_SUPPORTED Hardware information not supported Activate Hardware Supported Filtering
S3_INV_BASEPID Please enter valid basePID Supply Valid basePID
S3_INV_BASEPID Too many basePids in the request Please provide upto 10 or less basePids in the request
S3_INV_CURR_IMG_REL Given image doesn't correspond to the release Supply Images corresponding to release
S3_INV_IMAGE Please enter a valid image Please enter a valid image
S3_INV_INPUT Invalid inputs in url Please provide proper input values
S3_INV_MDFID Too many mdfIds in the request Please provide upto 10 or less mdfIds in the request
S3_INV_MDFID Invalid / non numeric mdfId Please enter valid numeric mdfId
S3_INV_QUERY_PARAM Invalid query parameters in url : contentType We support only json response. Please provide contentType as json/JSON
S3_INV_QUERY_PARAM Invalid query parameters in url : invalidQueryParam Please refer S3 API user guide for valid parameter names & values
S3_INV_QUERY_PARAM Invalid query parameters in url Please provide valid numeric values (1 <= pageIndex <=lastIndex ) for pageIndex
S3_INV_QUERY_PARAM Invalid query parameters in url : currentRelease Please provide proper current release
S3_INV_QUERY_PARAM Invalid query parameters in url : supportedHardware Please enter valid input
S3_INV_QUERY_PARAM Invalid query parameters in url : currentImage Please enter valid input
S3_INV_RELEASE Please enter a valid release version Please enter a valid release version
S3_INV_RELEASE_IMAGE Please enter a valid image and release version Please enter a valid image and release version
S3_MDFID_NO_SUPPORT Please enter valid baseMDF Please provide mdfId that is supported
S3_MDFID_REQ MDFID is a mandatory field Please provide a mdfId in the url
S3_NO_REC_FOUND No records found Supply Valid input parameters
S3_NO_SOFT_AVL No software available for this product Please provide a product which has software available
S3_SERVICE_EXCEPTION_OCCURED Supply Valid input parameters Supply Valid input parameters