EoX API (EOXBySerialNumber) help

[wkwk]

I have trying to use EOXBySerialNumber endpoint for some of network devices that have EoX dates. The problem is that not matter what serial number I use I get the same message.

ErrorID=SSA_ERR_010;

ErrorDescription=The serialNumbers value specified is invalid. Please correct the serialNumbers value and try again.

I verify that the serial numbers are valid using this site, "https://cway.cisco.com/sncheck/" so I don't understand the issue. Based on Cisco EoX DevNet site I have been able to get responses with values using these endpoints:

https://apix.cisco.com/supporttools/eox/rest/5/EOXByDates/{pageIndex}/{startDate}/{endDate}

https://apix.cisco.com/supporttools/eox/rest/5/EOXByProductID/{pageIndex}/{productID}

but no luck with the endpoint I want to use the EOXBySerialNumber

https://apix.cisco.com/supporttools/eox/rest/5/EOXBySerialNumber/{pageIndex}/{serialNumber}

thanks in advance for any help provided.

[bigevilbeard]

Just looked over some old threads, have you tried https://developer.cisco.com/docs/support-apis/serial-number-to-information/#get-coverage-summary-by-serial-numbers

GET https://apix.cisco.com/sn2info/v2/coverage/status/serial_numbers/FOC10220LK9

The error and i had to use some Google Fu to see this one: "The endpoint expects the serial numbers to be passed as a comma-separated string in the URL query parameters. The error "The serialNumbers value specified is invalid" is a generic response that often indicates a problem with how the data is being transmitted, not the data itself"

The endpoint you've listed (/eox/rest/5/EOXBySerialNumber/) is from an earlier API version that has been replaced. The current, supported version of the API uses a different structure from what i am seeing here. 

https://api.cisco.com/supporttools/eox/v1/by-serial-number/serialNumbers

The newer endpoint uses a different approach for passing the serial numbers, as a query parameter rather than a path variable. So an example i found was showing 

https://api.cisco.com/supporttools/eox/v1/by-serial-number/serialNumbers?serialNumbers=FHK221804B3,FHK221804N9

I could be wayyyyy wrong here. But worth checking.

[wkwk]

Thanks for looking into it but I don't see a reference to the endpoint you mentioned in the Cisco EoX WADL file. Can you share the link where you found  the endpoint below:

https://api.cisco.com/supporttools/eox/v1/by-serial-number/serialNumbers

Also, I don't currently have access to the sn2info API but it doesn't have the main 2 property values that I'm looking to gather automatically ( EoS and EoL).

[bigevilbeard]

Great, not sure how you get access to that API. I found the uri on the postman collection 

https://github.com/CiscoDevNet/Cisco_Support_API_Postman/blob/master/Support%20APIs%20-%20DevNet.postman_collection.json

[Jonatan Jonasson]

Just to share, I can't get the EOXBySerialNumber endpoint to work either, but I do end up with a different error/issue, like it's trying to parse the serial-nr as a product ID. (SSA_ERR_026).

Getting access to the sn2info is just similar to getting access to the EOX support-api, and and the process is described in the documentation:
https://developer.cisco.com/docs/support-apis/application-registration/
You can have Serial Number to Information (sn2info) in the same app registration as the EOX v5 API.

There's an email listed on the how-to-get-technical-support page that might provide better answers?
https://developer.cisco.com/docs/support-apis/developer-support/#getting-help

That being said, just based on previous experience working with the support apis.

In the past I've used sn2info to query based on serial numbers, which aside from serial-specific information (contract #, coverage, etc), will give me the base PID. And then after consolidation I used the EOXByProductID to query based on the PIDs I needed and got the desired results.

In the cases where I didn't need the serial-specific info, I realized that in most cases getting the PID of all the products I wanted to query was just as easy as getting the serial number.
Often an inventory will include both the PID and the SN, monitoring systems often discover both as well, and if I'm using a script to fetch the serial info from the devices I could as well just fetch the PID at the same time.
And since a lot of the devices are often sharing the same PID, I can reduce the number of API calls I need to make.
(Because  I don't have to batch query multiple serial numbers.)

[Jonatan Jonasson]

Just to add, there seem to be other threads regarding the EOXBySerialNumber not working anymore but was previously working, so the issue is probably on Cisco's side here.

Reference: https://community.cisco.com/t5/smart-net-total-care-portal-and-collector-discussions/eox-api-no-longer-returning-data-was-working-previously/m-p/5317597#M20348

A person in that thread said to have reached out to Cisco's API support and is waiting for a response from them.

[wkwk]

Thanks, I missed that thread but will now track them both until we get answer from support! I just wanted to make sure it wasn't something that I was doing wrong.

https://apix.cisco.com/supporttools/eox/rest/5/EOXBySerialNumber/1

What is interesting is that if you use the numbers 1 through 99 (as the serial numbers), the resource/endpoint does return a lot of data.

[wkwk]

Thanks for the reply. I have used the EOXByProductID successfully but already went down the line of using the serial number for input. The change would be simple enough to make but based on Cisco WADL this resource/endpoint should work. I have reached out to Cisco API support team to see if they answer.