Get API data with multiple ID

OwlGreen

Hello!

I need to get usernames from one api request with multiple ID, for example:
https://discuss.flarum.org/api/users/1

This request get api data from user ID 1, how to get data from users ID 1,2,3? I try this:

https://discuss.flarum.org/api/users/id?1,2,3
https://discuss.flarum.org/api/users?1&2&3
https://discuss.flarum.org/api/users?1,2,3

I need it to convert users id from api/notifications to usernames, because data correctly show only users id (who send reply, like, mention).

luceos

https://discuss.flarum.org/api/users?filter[id]=1,2,3,4

😉

Stolen from: https://github.com/flarum/framework/blob/78189f29d2e6f149e5a43c278575b2ee666e1e7a/framework/core/js/src/common/Store.ts#L174

Edit you can get the full fromUser payload as well by adding include=fromUser to your original request to the notifications endpoint. This relationship data will be appended outside of data in included.

OwlGreen

luceos

I have problem with included, I need show info about notifications like this:

New message from @Alex 
New messages from @Ben
New like from @Tom 
New like from @Ben
New reply from @Steven

If use this data relationships fromUser data id, I have a correctly result:

New message from id:1 
New messages from id:13
New like from id:4
New like from id:13
New reply from id:9

So, when I get username from included I have incorrect result like this:

New message from id:1 @Alex
New messages from id:13 @Ben
New like from id:4 @Tom
New like from id:13 @Steven
New reply from id:9 @

To fix it I try send multiple api request with id 1,13,4,9 from data relationships fromUser data id to get data attributes username and after replace this data relationships fromUser data id to result from multiple api request.

luceos

OwlGreen why is the payload from included incorrect? They are exactly the correct information I expect when I hit https://discuss.flarum.org/api/notifications

OwlGreen

luceos incorrect because in my example we have 5 notifications from 4 users, so if use data relationships fromUser data id from this request id value correctly set for all 5 notifications:

New message from id:1 
New messages from id:13
New like from id:4
New like from id:13
New reply from id:9

So included attributes username give only 4 username Alex Ben Tom Steven without association with a specific notification and we have result like this:

New message from @Alex
New messages from @Ben
New like from @Tom
New like from @Steven
New reply from @

5 notification don't have a username value.

SychO

OwlGreen you only have 4 users though: id 1, id 13 id 4 and id 9

OwlGreen

SychO Yes. I need to associated this 4 users with 5 notifications from this users 🥲
I think need change flarum core (api) to add information about username in result data relationships fromUser data from api/notifications separately for each notification.

luceos

OwlGreen that is not necessary. The relation has a type and an id, if you look at the included array it has type, id, and attributes. You will need to seed your included into memory, then match the relationship against the type + id. Adding a username to the relationship information is redundant, because we provide all the information to match it against an entry from included.

clarkwinkelmann

Flarum follows the json:api standard for REST API format. If you'd rather not parse the content manually you can find ready to use libraries for many programming languages https://jsonapi.org/implementations/

There shouldn't be any need to make a separate request in Flarum because all useful data is already part of the included payload as luceos describes. There are also a few more relationships that can be included on demand on some of our endpoints, you sometimes see them when inspecting the requests made by the Flarum single page application.

OwlGreen

clarkwinkelmann

username value from included does not apply to a specific notification id.
Therefore, I can't specify a username for each notification, because if I get username from included, have this:

the id get from relationships fromUser data id

New message from id:1
New messages from id:1
New messages from id:2
New messages from id:3
New messages from id:3
New like from id:4
New like from id:4
New like from id:1
New like from id:3
New reply from id:2

the get username from included

New message from id:1 - @Alex
New messages from id:1 - @Ben - why @Ben if id:1 it's @Alex?
New messages from id:1 - @Tom - ???
New messages from id:3 - @Steven
New messages from id:2 - ???
New like from id:4 - ???
New like from id:4 - where username @Steven?
New like from id:1 - where username @Alex?
New like from id:3 - ???
New reply from id:2 - ???

Should be

the get username from included

New message from id:1 - @Alex
New messages from id:1 - @Alex
New messages from id:1 - @Alex
New messages from id:3 - @Tom
New messages from id:2 - @Ben 
New like from id:4 - @Steven
New like from id:4 - @Steven
New like from id:1 - @Alex
New like from id:3 - @Tom
New reply from id:2 - @Ben

clarkwinkelmann

OwlGreen are you able to share an entire JSON response where the content doesn't match, and maybe the corresponding screenshot from Flarum UI?

The same API payload is used by Flarum to build the notification dropdown, so if the data is wrong in the JSON it should also be wrong in Flarum's UI.

If Flarum UI looks good, either there's confusion about which relationship means what or there's a bug in your implementation to parse that data. If we see the whole payload we should be able to clear this up.

What intrigues me is that you cannot find some user IDs in the included payload. Based on Flarum's implementation, that shouldn't be possible under any circumstance. Not including a resource that's referenced in a relationship is also not allowed by the json:api spec. The only place where we break this rule is when returning the list of posts in a discussion for infinite scroll.

OwlGreen

clarkwinkelmann are you able to share an entire JSON response where the content doesn't match, and maybe the corresponding screenshot from Flarum UI?

This forum have the same "problem", this is screenshot of my notifications on discuss.flarum.org

https://discuss.flarum.org/api/notifications show 10 notifications with users id relationships":{"fromUser":{"data":{"type":"users","id":"123"

"data":[
{"type":"notifications","id":"447758","attributes":{"contentType":"postMentioned","content":{"replyNumber":12},"createdAt":"2022-12-12T18:32:26+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"5855"}},"subject":{"data":{"type":"posts","id":"209143"}}}},

{"type":"notifications","id":"447753","attributes":{"contentType":"postMentioned","content":{"replyNumber":9},"createdAt":"2022-12-12T14:44:29+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"1376"}},"subject":{"data":{"type":"posts","id":"209139"}}}},

{"type":"notifications","id":"447747","attributes":{"contentType":"postMentioned","content":{"replyNumber":7},"createdAt":"2022-12-12T14:08:57+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"20612"}},"subject":{"data":{"type":"posts","id":"209136"}}}},

{"type":"notifications","id":"447741","attributes":{"contentType":"postMentioned","content":{"replyNumber":5},"createdAt":"2022-12-12T12:10:54+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"1376"}},"subject":{"data":{"type":"posts","id":"209134"}}}},

{"type":"notifications","id":"447206","attributes":{"contentType":"postMentioned","content":{"replyNumber":2},"createdAt":"2022-12-08T15:59:05+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"5855"}},"subject":{"data":{"type":"posts","id":"208954"}}}},

{"type":"notifications","id":"446711","attributes":{"contentType":"postMentioned","content":{"replyNumber":2},"createdAt":"2022-12-04T09:43:07+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"1376"}},"subject":{"data":{"type":"posts","id":"208817"}}}},

{"type":"notifications","id":"446656","attributes":{"contentType":"postMentioned","content":{"replyNumber":31},"createdAt":"2022-12-03T18:09:17+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"5855"}},"subject":{"data":{"type":"posts","id":"208766"}}}},

{"type":"notifications","id":"446574","attributes":{"contentType":"postMentioned","content":{"replyNumber":5},"createdAt":"2022-12-03T11:03:55+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"1376"}},"subject":{"data":{"type":"posts","id":"208764"}}}},

{"type":"notifications","id":"432374","attributes":{"contentType":"postLiked","content":null,"createdAt":"2022-09-08T08:30:51+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"7315"}},"subject":{"data":{"type":"posts","id":"203467"}}}},

{"type":"notifications","id":"431323","attributes":{"contentType":"postMentioned","content":{"replyNumber":2},"createdAt":"2022-09-02T21:05:28+00:00","isRead":true},"relationships":{"fromUser":{"data":{"type":"users","id":"5855"}},"subject":{"data":{"type":"posts","id":"204352"}}}}
]

and included with 4 usernames

"included":[

{"type":"users","id":"5855","attributes":{"username":"clarkwinkelmann","displayName":"clarkwinkelmann","avatarUrl":"https:\/\/discuss.flarum.org\/assets\/avatars\/41BOlYLjizzhvecT.png","slug":"clarkwinkelmann"}},

{"type":"users","id":"1376","attributes":{"username":"luceos","displayName":"luceos","avatarUrl":"https:\/\/discuss.flarum.org\/assets\/avatars\/fNVaAawAMvap1S2g.png","slug":"luceos"}},

{"type":"users","id":"20612","attributes":{"username":"SychO","displayName":"SychO","avatarUrl":"https:\/\/discuss.flarum.org\/assets\/avatars\/Mzqcew3iinTlh7L0.png","slug":"SychO"}},

{"type":"users","id":"7315","attributes":{"username":"hrvoje_hr","displayName":"hrvoje_hr","avatarUrl":"https:\/\/discuss.flarum.org\/assets\/avatars\/6dzToMOo3csm5fbx.png","slug":"hrvoje_hr"}},

Question: How to correlate this 4 usernames from included with 10 notifications? Like this https://discuss.flarum.org/d/32131-get-api-data-with-multiple-id/11

clarkwinkelmann

OwlGreen I'm not seeing any issue in that payload. All user IDs appear to have a matching record in included.

Are you sure you are looking up the included data by the user ID listed in the relationship and not the notification ID? In your previous messages if you list the first 3 messages have user ID 1, there's no way you get different usernames unless you are somehow looking up different user IDs.

If you really need to make a separate API request, it should be as simple as taking every ID from the relationships data and using those in the URL. But all of that data is already in included so that doesn't seem to bring any benefit unless you need access to relationships on the user object which have not been made available on the notification endpoint. And even then it would be very simple to whitelist any additional relationship using a PHP extender to avoid having to make a second request.

The IDs are always the id properties in the JSON, never indexes. The order of the records in included is not guaranteed and might change, however the type and id property combination is guaranteed to have a match.