1001161 - ImageURL of systems/issuers/programs is not returned from getBadge method in badgekit-api-client

Status: RESOLVED WONTFIX

(Webmaker Graveyard :: Badges, defect)

Description

[inactivate account for kate]

Let's add that so we can have an issuer avatar

Comment 1

[Erik Christensen [:christensenep][:echristensen]]

So, this turns out to be a pretty universal issue with all of BadgeKit API's endpoints, and I think in most cases it falls more into the realm of questionable design than actual bug.  Basically, the badge endpoints (and many other endpoints) generally return the full data associated with the object you requested, as well as more basic data of associated objects (in this case, that means full data of the badge requested, as well as abbreviated data of the system/issuer/program that the badge belongs to).

What's unintuitive is that imageUrls are not currently part of that "abbreviated" data.  Almost certainly they should be, but it's a pretty invasive change to make it happen universally without some changes to our ORM component.

I mention all of this only to explain why this is probably not a same-day fix.  What IS both unquestionably a bug (and quickly fixable) is that issuer.imageUrl is showing up at all (even as null) in the data returned.  It shouldn't be, and I'll get a fix in for that shortly, but the larger issue here should probably remain open for now.

For the time being, a call to getIssuer() (via badgekit-api-client) to fetch the full issuer data (including image data) should get you what you need, hopefully without too much pain and suffering.

Comment 2

[inactivate account for kate]

We don't really need this