API to get lineups doesn't return "code"

[ronf]

When testing the API to get the current set of lineups, I noticed that the returned JSON doesn't have a 'code' value like most of the other APIs. I was hoping I could count on this being present in all return values, so I could keep my error handling in a common function, always looking for 'code' to be 0 to indicate success.

Also, if you call this API when there are no lineups added for the user, it returns an HTTP 400 Bad Request error. It would be better to return an empty list here, or at least some kind of JSON error rather than an HTTP error.

[rkulagowski]

API-20141201 now returns a code "0" if there are no errors.

As to the 400 error, if your client looks at the returned data and not just the HTTP response code, the "internal" error is 4102 -> "No lineups have been added to this account."

[garybuhrmaster]

I would have to agree with the OP, I would naturally expect that the HTTP response would be a 200, with an empty list, since the request itself is successful (same for get headends if there are no headends in the country/postal code). For my app, for a couple of cases, I have explicit checks for a 400 error, and the (appropriate) code for the request, and then convert that to the appropriate empty list. Perhaps a code of non-zero could provide the equivalent warning if that was desired (HTTP response 200, empty list, json data include a code of 4102 (no lineups)).

But, regardless, I would agree it is just a matter of having adequate documentation so that the requests and responses can be handled properly. I look forward to better documentation on all the possible return codes and cases such as this.