Forum Discussion

neel_psl's avatar
neel_psl
Ace
8 years ago

API to get list of all available Ranks in community?

Is there any API through which i can get list of all available Ranks present in the community? As i need to show where a specific user is standing among all the Ranks present in the community (like ...
GlowingBlue_sc's avatar
GlowingBlue_sc
Ace

Really?? I'm speechless... so to actually get a list of all existing ranks we have to contact support even though there is an official API call for it in v1 and v2 and neither of them works properly...

 

The v1 call to ranks/list asks for a specific user login or id (via URL parameter) which completely defeats it's purpose, I don't want a USER's rank, I want ALL ranks in the community (this time for translation purposes).

 

<response status="error">
<error code="306">
<message>
A required feature is not configured: user-node-rank.
</message>
</error>
</response>

 

The v2 call documented here https://community.lithium.com/t5/Developer-Documentation/bd-p/dev-doc-portal?section=commv2&collection=ranks#fields-id just returns an error on a 17.12 (17.12-release r1803051017) community...

 

{
  "status" : "error",
  "message" : "undefined collection: ranks",
  "data" : {
    "type" : "error_data",
    "code" : 602,
    "developer_message" : "",
    "more_info" : ""
  },
  "metadata" : { }
}

SuzieH do you know why this is documented but then throws an error like that? It says nowhere that this has to be custom enabled by support?? I'm simply trying

SELECT * FROM ranks

If that's really something that needs to be first enabled by support, please add it to the docs so any confusion and waste of time is avoided in the future.

SuzieH's avatar
SuzieH
Khoros Alumni (Retired)
7 years ago

Hi GlowingBlue_sc,

We don't provide a v2 API to get a list of all ranks in the Community. I apologize for the confusion in the Ranks collection documentation, The sentence about the Fields table that says "Fields in this table are supported in the SELECT statement of a LiQL query." Is auto-generated, and is a mistake. With v2, you only retrieve ranks for a specific user or a set of users. 

 

In addition, I spoke with of our Community engineers. The ranks/list endpoint is actually used to retrieve a list of Category Expert Ranks (which is called UserNodeRanks in our code), not User Ranks. I'll be clarifying that in the documentation as well. We have a TKB describing the differences between these features here.