Error and Response Messages

Common Error Messages

This section describes the error messages which may be returned by the different API methods. For any error message returned, the following applies:

  1. If the response is Not Authorized, that means the access token has expired. In this case, a new token needs to be generated.
  2. If the response is Invalid client, make sure that the Client id and Client secret are valid for the partner.

Error Message Request processed successfully. Returning x of y devices.

Explanation

Here x is the exact number of devices if the number is less than 10k, and 10k if the number is more than 10k. And y is the exact number of devices.

Error Message INVALID-CUSTOMER-ID-101

Explanation

Invalid Customer Id.

Recommended Action

The customer id passed is not valid.

Error Message INVALID-INVENTORY-ID-102

Explanation

Invalid Inventory Id.

Recommended Action

The inventory id passed is not valid.

Back to Top / Back Home

Error Message EMPTY-CUSTOMER-ID-103

Explanation

Customer Id needs to be provided in the input.

Recommended Action

The customer id is not passed.

Error Message EMPTY-INVENTORY-ID-104

Explanation

Inventory Id needs to be provided in the input.

Recommended Action

The inventory id is not passed.

Error Message INVALID-DEVICE-ID-105

Explanation

Invalid Device ID.

Recommended Action

The device id passed is not valid.

Back to Top / Back Home

Error Message EMPTY-PARTY-ID-106

Explanation

Global Ultimate PartyId is not available in the request header.

Recommended Action

If you encounter this error please contact Cisco Technical Support (http://www.cisco.com/cisco/web/support/index.html). When opening a case, Select Product: Smart Services Capabilities / Smart API.

Error Message XML-DATE-100

Explanation

Error while parsing date into XMLGregorianCalendar.

Recommended Action

Invalid Date. Please provide date in XMLGregorianCalendar format (e.g. 2007-04- 05T00:00:00.000).

Error Message GUID-CODE-101

Explanation

Invalid Global Ultimate Party Id.

Recommended Action

If you encounter this error please contact Cisco Technical Support (http://www.cisco.com/cisco/web/support/index.html). When opening a case, Select Product: Smart Services Capabilities / Smart API.

Back to Top / Back Home

Error Message ACS-100

Explanation

Problem was encountered while fetching access privileges. Cannot return data for this service at this time. Try again later.

Recommended Action

If you encounter this error please contact Cisco Technical Support (http://www.cisco.com/cisco/web/support/index.html). When opening a case, Select Product: Smart Services Capabilities / Smart API.

Error Message INVALID-ERP-PARTY-102

Explanation

Given Customer Id does not belong to Global Ultimate PartyId.

Recommended Action

The customer id passed is not valid.

Error Message INVALID-INVENTORY-ERP-PARTY-102

Explanation

Given Inventory does not belong to Customer Id.

Recommended Action

The inventory id passed does not belong to Customer Id passed.

Back to Top / Back Home

Error Message INV-INVALID-CUSTOMERID-101

Explanation

Invalid Customer Id.

Recommended Action

The customer id passed is not valid.

Error Message NO-INV_DATA-10

Explanation

No Partner available for given input parameter(s).

Recommended Action

No Partner is available for the passed input parameter(s).

Error Message SQL-101

Explanation

Problem was encountered while fetching data from data base.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support (http://www.cisco.com/cisco/web/support/index.html). When opening a case, Select Product: Smart Services Capabilities / Smart API.

Back to Top / Back Home

Error Message DB-101

Explanation

Lost access to the database.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support (http://www.cisco.com/cisco/web/support/index.html). When opening a case, Select Product: Smart Services Capabilities / Smart API.

Error Message MESSAGE_TYPE_FAILURE

Explanation

The response failed for the API request.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support (http://www.cisco.com/cisco/web/support/index.html). When opening a case, Select Product: Smart Services Capabilities / Smart API.

Error Message REQUEST_FAILURE_MESSAGE

Explanation

No data is available for given input parameters.

Back to Top / Back Home

Error Message EXCEED-MAX-LIMIT-101

Explanation

API cannot respond due to the big size of the inventory.

Error Message MAX_SIZE_EXCEED_DTL

Explanation

API cannot respond due to the big size of the inventory.

Error Message MAX_SIZE_EXCEED_CAUSE

Explanation

Inventory size is too big.

Back to Top / Back Home

Remaining Error Messages

PSS Token API Error Messages

Error Message invalid_client

Explanation

ERR_403_DEVELOPER_INACTIVE

Recommended Action

Make sure that the Client id and Client secret are valid for the partner.

Back to Top / Back Home

getCustomersInventoryIDs

Error Message INVENTORY-SVC-CODE-103

Explanation

Inventory Service Exception.

Recommended Action

If you encounter this error please contact Cisco Technical Support (http://www.cisco.com/cisco/web/support/index.html). When opening a case, Select Product: Smart Services Capabilities / Smart API.

Back to Top / Back Home

getCustomerExtendedInventoryDetails

Error Message INVALID-PAGE-START-101

Explanation

Please enter a valid pageStart between x and y.

Recommended Action

If any number which is not between 1 and <pageTotal> is passed into the pageStart input parameter, the message ‘Please pass a valid pageStart between 1 and <pageTotal>’ is returned in the response. Pass a valid pageStart parameter.

Error Message INVALID-PAGESTART-ID-108

Explanation

If any value other than a number is passed in the pageStart input parameter, the message ‘Invalid pageStart’is returned in the response. Pass a numeric value.

Recommended Action

Please pass a valid pageStart between 1 and <pageTotal>.

Error Message INVALID-CUSTOMER-ID-101

Explanation

Invalid Customer Id.

Recommended Action

The customer Id passed is not valid.

Back to Top / Back Home

Error Message INVALID-INVENTORY-ID-102

Explanation

Invalid Inventory Id.

Recommended Action

The inventory Id passed is not valid.

Error Message INVALID-INVENTORY-ERP-PARTY-102

Explanation

Given Inventory does not belong to Customer Id.

Recommended Action

The inventory Id passed does not belong to Customer Id passed.

Back to Top / Back Home

getCustomerInventoryPaginatedDetails

Error Message INVALID-PAGE-START-101

Explanation

Please enter a valid pageStart between x and y.

Recommended Action

If any number which is not between 1 and <pageTotal> is passed into the pageStart input parameter, the message ‘Please pass a valid pageStart between 1 and <pageTotal>’ is returned in the response. Pass a valid pageStart parameter.

Error Message INVALID-PAGESTART-108

Explanation

If any value other than a number is passed in the pageStart input parameter, the message ‘Invalid pageStart' is returned in the response. Pass a numeric value.

Back to Top / Back Home

getContractCoverageDetails

Error Message CONTRACT-INVALID-DEVICE-CODE-100

Explanation

Invalid Device Id.

Recommended Action

The device id passed is not valid.

Error Message CONTRACT-1001

Explanation

Problem encountered while fetching Contract Coverage. Please contact Cisco Technical Support (http://www.cisco.com/cisco/web/support/index.html).

Recommended Action

'Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Back to Top / Back Home

getNPDRDetails

Error Message NPDR-SVC-CODE-103

Explanation

Error while fetching the NPDR information.

Error Message NPDR-DATE-CODE-101

Explanation

The upload Date and Time format is incorrect.

Recommended Action

Please pass the correct format for uploadDateAndTime ( e.g. 2007-04-05T00:00:00.000).

Error Message INVALID-APPLIANCE-ID-101

Explanation

Invalid Appliance Id.

Recommended Action

Re-enter proper Appliance ID.

Back to Top / Back Home

getFNDetails

Error Message INVALID-ALERT-ID-101

Explanation

Invalid Alert ID.

Recommended Action

The alert id passed is not valid.

Error Message FN-INVALID-ID-101

Explanation

ERROR Invalid FN ALERT Id.

Recommended Action

Invalid field notice ID. Please pass correct 'fnId'.

Error Message FN-SVC-CODE-103

Explanation

FN SERVICE EXCEPTION.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Back to Top / Back Home

getPSIRT

Error Message PSIRT-101

Explanation

Error Fetching PSIRT Alerts for device/inventory.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Error Message PSIRT-102

Explanation

Please check Database Connection , it is null.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Error Message PSIRT-GETPSIRT-104

Explanation

ERROR while getting PSIRT Information.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Error Message PSIRT-SVC-CODE-103

Explanation

PSIRT SERVICE EXCEPTION.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Back to Top / Back Home

getPSIRTDetails

Error Message PSIRT-ID-100

Explanation

PSIRT IDs are not valid.

Recommended Action

Invalid PSIRT ID. Please pass correct 'psirtId'.

Back to Top / Back Home

getIS

Error Message IS-101

Explanation

Error Fetching IS Alerts for device/inventory.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Error Message IS-SVC-CODE-103

Explanation

IS Service Exception.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Back to Top / Back Home

getISDetails

Error Message EMPTY-ISALERT-ID-102

Explanation

IS AlertIds need to be provided in the input.

Error Message INVALID-ALERT-ID-101

Explanation

Invalid Alert ID

Recommended Action

The alert id passed is not valid.

Back to Top / Back Home

getSwEoxBulletins

Error Message SW-101

Explanation

Error Fetching SW Alerts for device/inventory.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Error Message HW-SVC-CODE-103

Explanation

SW SERVICE EXCEPTION.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Error Message EMPTY-SWALERT-ID-102

Explanation

softwareEoXId needs to be provided in the input.

Back to Top / Back Home

getHwEox

Error Message HW-101

Explanation

Error Fetching HW Alerts for device/inventory.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Error Message HW-SVC-CODE-103

Explanation

HW SERVICE EXECEPTION.

Recommended Action

Internal Server Error. Please retry. If the problem still persists please contact Cisco Technical Support. (http://www.cisco.com/cisco/web/support/index.html). When opening a case, select Product: Smart Services Capabilities / Smart API.

Back to Top / Back Home

getHwEoxBulletins

Error Message EMPTY-HWALERT-ID-102

Explanation

HwEox AlertId(s) need to be provided in the input.

Error Message INVALID-ALERT-ID-101

Explanation

Invalid Alert ID.

Recommended Action

The alert id passed is not valid.

Back to Top / Back Home

getHwEoxMigrationPIDs

Error Message EMPTY-HWMIGRATION-ID-107

Explanation

Hw Migration Ids need to be provided in the input.

Back to Top / Back Home

Remaining Error Messages

This table describes the common message responses returned by the different API methods.

Common message responses:
REQUEST_SUCCESS_MESSAGE Request processed successfully.
REQUEST_FAILTURE_MESSAGE No data available for given input parameters.
MESSAGE_TYPE_SUCCESS Request processed successfully.
MESSAGE_TYPE_FAILURE FAILURE.
DEVICE_ALERT_SUCCESS Successfully got the alerts ids.
DEVICE_ALERT_FAILURE No alerts present for the given parameters.
ALERT_DETAILS_SUCCESS Successfully got the Alert Details.
ALERT_DETAILS_FAILURE Alert Details are not available for the given alert ids.
MIGRATION_PID_DETAIL_FAILURE Migration Pid Details are not available for the given alert ids.
MIGRATION_PID_DETAIL_SUCCESS Successfully got the Migration Pid Details.
MAX_SIZE_EXCEED_CODE EXCEED-MAX-LIMIT-101.
MAX_SIZE_EXCEED_DTL API cannot respond due to big size of inventory.
MAX_SIZE_EXCEED_CAUSE Inventory size is too big.
Request processed successfully. Returning x of y devices Here x is the exact number of devices, if the number is less than 10k, and 10k if the number is more than 10k, and y is the exact number of devices.

Back to Top / Back Home

API Service Maintenance Downtime Message (503)

The API Service Downtime Message will be returned when the PSS API services are unavailable due to scheduled maintenance.

The affected APIs and downtime duration included in the message will be returned to the calling application.


    <API_MESSAGE>
        <SCHEDULED_MAINTENANCE_503>
        <API_EFFECTED>getIS</API_EFFECTED>
        <API_EFFECTED>getISDetails</API_EFFECTED>
        <API_EFFECTED>getPSIRT</API_EFFECTED>
        <API_EFFECTED>getPSIRTDetails</API_EFFECTED>
        <START_TIME>12/22/2013 10:00AM PST</START_TIME>
        <END_TIME>12/22/2013 02:00PM PST</END_TIME>
        <MESSAGE>PSS APIs are unavailable from start-time to end-time.</MESSAGE>
        </SCHEDULED_MAINTENANCE_503>
    </API_MESSAGE>

Response Parameter(s)

Scheduled_Maintenance_503

Parameter Type Length Description
API_EFFECTED string 100 The API service effected by the downtime.
START_TIME string 50 The start time of service unavailability.
END_TIME string 50 The end time of service unavailability.
MESSAGE string 10000-
15000		 Message Content:
    PSS APIs are unavailable from start-time to end-time.
Where start time and end time may be either PST or PDT.

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.