14 Replies Latest reply on Jun 2, 2014 7:39 AM by bcarpenter@reliaslearning.com

API call to return only Location field

bcarpenter@reliaslearning.com May 19, 2014 1:37 PM

Hi all!

So we're working with a developer to create an interactive map on our main page. He had a question regarding the API call. Currently he is calling all users then filtering from those results the ones who have the location filled out. Is there a way to do this with the call so it doesn't return a lot of unnecessary information?

Here is the call he's currently using: https://rlconnect.reliaslearning.com/api/core/v3/people?sort=firstNameAsc&fields=displayName%2Clocation%2Cname

Do you guys have any thoughts on this?

Thanks!

Re: API call to return only Location field

Ryan Rutan May 19, 2014 2:20 PM (in response to bcarpenter@reliaslearning.com)

Try adding -resources to the end of the fields filter, such as
https://rlconnect.reliaslearning.com/api/core/v3/people?sort=firstNameAsc&fields=displayName%2Clocation%2Cname%2C-resources
Like (0)

Actions
- Re: API call to return only Location field
  
  bcarpenter@reliaslearning.com May 21, 2014 8:14 AM (in response to Ryan Rutan)
  
  Hi Ryan!
  I passed this along to the developer and he said that it only removes the resources information, and doesn't restrict the results. Do you have any other tricks?
  
  Like (0)
  
  Actions
  - Re: API call to return only Location field
    
    Ryan Rutan May 21, 2014 8:18 AM (in response to bcarpenter@reliaslearning.com)
    
    Sorry, have them use that in conjunction with the location field key on the fields filter, such as ?fields=id,location,-resources
    
    Like (0)
    
    Actions
    - Re: API call to return only Location field
      
      bcarpenter@reliaslearning.com May 29, 2014 12:28 PM (in response to Ryan Rutan)
      
      Hi Ryan!
      Would you be willing to work directly with the developer on this? The call that he's using is pulling in ~250 people with valid location, when there should actually be closer to 500. I'm not sure why this would be the case.
      
      Like (0)
      
      Actions
    - Re: API call to return only Location field
      
      bcarpenter@reliaslearning.com May 29, 2014 2:11 PM (in response to Ryan Rutan)
      
      Also Ryan, is it possible to use the ?filter=location() to specify a certain length of string? For example, could we say something along the lines of "only show locations with 5 numbers"?
      
      Thanks!
      
      Like (0)
      
      Actions
    - Re: API call to return only Location field
      
      bcarpenter@reliaslearning.com May 30, 2014 6:22 AM (in response to Ryan Rutan)
      
      Craig McClanahan, I wonder if you might have some insight as well... I've noticed your posts in quite a few API related threads.
      
      To explain myself better, we have a list of users that we want the location for that we are trying to call via API, however, some of those do not have the location field filled out. Instead of filtering these results after the API call, is it possible to only show those results with people who have filled out the Location field? Would some filter or query work?
      
      Thanks!
      
      Like (0)
      
      Actions
      - Re: API call to return only Location field
        
        Ryan Rutan May 30, 2014 6:57 AM (in response to bcarpenter@reliaslearning.com)
        
        Based on what's in the documentation:
        https://developers.jivesoftware.com/api/v3/cloud/rest/PersonService.html#getPeople(String, String, int, int, String, List<String>, String, String)
        which specifies a location filter for only an exact Single match on the location field...I do not think this is possible. If you can find another way to filter these people out of the results, then you can explore that option; however, if you cant, then the only option I see is to process the rows in batches and post-process the ones with matching field values.
        
        Hope that helps.
        
        Note: I tried fiddling with the location filter to see if there were any undocumented wildcards, such as +, *, % etc.. and didn't stumble across any.
        
        Like (1)
        
        Actions
        
        Re: API call to return only Location field
        
        craig.mcclanahan May 30, 2014 9:25 AM (in response to Ryan Rutan)
        
        There isn't any hidden magic -- unless otherwise explicitly stated, all of the filters match on exact matches only. And there is not currently a filter that says "only return people who have filled out (or not filled out) field X".
        1 person found this helpful
        
        Like (1)
        
        Actions
        
        Re: API call to return only Location field
        
        bcarpenter@reliaslearning.com May 30, 2014 1:22 PM (in response to craig.mcclanahan)
        
        Thanks guys! I really appreciate the responses.
        
        Another thing I wanted to ask was that I've made our developer an admin on our page. His API call is only producing ~250 entries with a valid location filled out when there are actually over 500 that should be showing up. What would be the reason for that? He has full admin access so the permissions should be the same...
        
        Like (0)
        
        Actions
        
        Re: API call to return only Location field
        
        craig.mcclanahan May 30, 2014 3:16 PM (in response to bcarpenter@reliaslearning.com)
        
        By "admin on our page" does that mean you made him a group admin for a social group? If so, that won't let him see any profile fields that your users have marked as private -- you need Jive "Full Access" (assigned as a user override in the admin console) for that to work. Otherwise, the developer will still be restricted by profile privacy settings.
        
        Like (0)
        
        Actions
        
        Re: API call to return only Location field
        
        bcarpenter@reliaslearning.com May 31, 2014 6:02 AM (in response to craig.mcclanahan)
        
        Hi Craig,
        
        He's set up as a Jive Full Access member in the admin console.
        
        ~~
        Brett
        
        Sent from my Verizon Wireless 4G LTE DROID
        
        Like (0)
        
        Actions
        
        Re: API call to return only Location field
        
        bcarpenter@reliaslearning.com Jun 2, 2014 7:13 AM (in response to bcarpenter@reliaslearning.com)
        
        Hi all!
        
        I was also wondering if there's a field that can call the Username of a user? I'm looking here: Jive REST Rest API v3.6 → Person service and notice there is a section labeled "Get Person By Username" but I'm trying to include the username in the list of all users. I've tried adding ?fields=username to my API call, but it doesn't seem to return the field.
        
        Like (0)
        
        Actions
        
        Re: API call to return only Location field
        
        Ryan Rutan Jun 2, 2014 7:38 AM (in response to bcarpenter@reliaslearning.com)
        
        If you do a GET for a user, you should see that the username is located under the jive stanza, so adding this as a filter should do the trick:
        fields=jive.username
        
        Hope that helps.
        1 person found this helpful
        
        Like (2)
        
        Actions
        
        Re: API call to return only Location field
        
        bcarpenter@reliaslearning.com Jun 2, 2014 7:39 AM (in response to Ryan Rutan)
        
        You rock Ryan! Thanks!!
        
        Like (1)
        
        Actions