Aggiefeed REST API GET api_v1_activity

Owned by Thomas Amsler
Last updated: Dec 03, 2015
1 min read
Aggiefeed REST API: GET /api/v1/activity


Headers:

Headers

Comments

Authorization: ApiKey <api key>

Requires API KEY
e.g.
Authorization: ApiKey abcdefgh


Query String Parameters:

Parameter

Name

Required (R)
Optional (O)

Format

Min / Max Value

Comments

Example

s

Skip

R

number

min: 0
max : 4000

Used for result pagination

s=10

l

Limit

R

number

min: 0
max: 200

Used for result pagination

l=100

u

User ID

O

string

N/A

Retrieve activities for a specific user and the groups he/she is associated with
Must be user's kName

u=userId

t

Activity Type

O

string

N/A

Specify one or more activity types

t=notification
t=notification&t=news

m

Activity Label

O

string

N/A

Specify one or more activity labels
System level labels are:

  • ~campus-life
  • ~student-life
  • ~academic
  • ~campus-messages

m=~academic
m=~academic&m=~campus-life

oActivity Source OriginOstringN/ASpecify one or more activity sources

o=mondavi-rss

o=mondavi-rss&o=athletics-rss

sd

Activity Start Date

O

ISO-8601 Date
YYYY-MM-DDTHH:mm:ss.SSSZ

N/A

Specify the activities start date (In Zulu Time)

sd=2013-06-27T22:00:00.000Z

ed

Activity End Date

O

ISO-8601 Date
YYYY-MM-DDTHH:mm:ss.SSSZ

N/A

Specify the activities end date (In Zulu Time)

ed=2013-06-28T22:00:00.000Z

 

How to Use Query String Parameters:

  • Specifying multiple Query String Parameters of the same type will match any (OR)
  • Specifying multiple Query String Parameters of different types will narrow the result like an (AND)


e.g. 1:
t=notification&m=~campus-life&m=~academic
t=notification AND ( m=~campus-life OR m=~academic )

e.g. 2:
u=userId&t=notification&t=news&m=~campus-life&m=~academic
u=userId AND ( t=notification OR t=news ) AND ( m=~campus-life OR m=~academic)

e.g. 3:
u=userId&t=news&m=~campus-life&m=~academic&sd=2013-06-28T22:00:00.000Z
u=userId AND t=news AND ( m=~campus-life OR m=~academic ) AND sd=2013-06-28T22:00:00.000Z

e.g. 4:
u=userId&t=news&m=~campus-life&m=~academic&sd=2013-06-28T22:00:00.000Z&ed=2013-07-05T06:00:00.000Z
u=userId AND t=news AND ( m=~campus-life OR m=~academic ) AND sd=2013-06-28T22:00:00.000Z AND ed=2013-07-05T06:00:00.000Z

 

Testing using "curl":

curl -H "Authorization: ApiKey <api kei>" -i -X GET -G -d 's=0&l=100&u=userId&t=notification&m=~campus-life&m=~academic&sd=2013-06-28T22:00:00.000Z&ed=2013-07-05T06:00:00.000Z' "https://aggiefeed-test.ucdavis.edu/api/v1/activity"