...
Aggiefeed REST API: POST /api/v1/activity
Headers:
Headers | Comments |
|---|---|
Authorization: ApiKey <api key> | Requires API KEY |
Full Example:
| Code Block |
|---|
Authorization: ApiKey abcdefgh HTTP POST https://aggiefeed.ucdavis.edu/api/v1/activity BODY = { "activity" : <activity JSON> } |
POST Body:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"activity" : {
<activity JSON>
}
}
|
Activity fields: |
...
Key
...
Type
...
Comment
...
Required (R)
Optional (O)
...
priority
...
Number
...
Use 0.0
...
R
...
icon
...
String
...
Any available Twitter Bootstrap icon name
...
R
...
actor
...
Object
...
...
R
...
actor.id
...
String
...
Unique Actor ID (This will be provided by the Aggie Feed Team)
...
R
...
actor.objectType
...
String
...
One of ["person", "department"]
...
R
...
actor.displayName
...
String
...
Department Name
...
R
...
actor.author
...
Object
...
...
R
...
actor.author.id
...
String
...
Unique Author ID (kName)
...
R
...
actor.author.displayName
...
String
...
Author Name (FirstName LastName)
...
R
...
verb
...
String
...
Use "post"
...
R
...
title
...
String
...
Activity Title
...
R
...
object
...
Object
...
...
R
...
object.id
...
String
...
Unique Content ID
...
R
...
object.objectType
...
String
...
Use "notification"
...
R
...
object.content
...
String
...
Activity content (Text)
...
R
...
to
...
Object
...
NOTE: The "to" field has to have one or both of the following properties: [ groups, users ]
...
R
...
to.groups
...
Array
...
Array of group names: "public", "students", "faculty", "staff"
e.g. ["students", "faculty"]
...
R / O
...
to.users
...
Array
...
Array of user kNames
e.g. �¯�»�¿["username1", "username2"]
...
R / O
...
published
...
String
...
ISO-8601 Date format YYYY-MM-DDTHH:mm:ss.SSSZ
The date needs to be in Zulu Time
e.g.
2013-07-01T17:00:00.000Z
...
O
...
ucdEdusMeta
...
Object
...
...
R
...
ucdEdusMeta.labels
...
Array
...
Array of strings. The array needs to contain at least one of the following labels: ["academic", "campus-life"]
...
R
...
ucdEdusMeta.startDate
...
String
...
ISO-8601 Date format YYYY-MM-DDTHH:mm:ss.SSSZ
The date needs to be in Zulu Time
e.g.
2013-07-01T17:00:00.000Z
...
O
...
ucdEdusMeta.endDate
...
String
...
ISO-8601 Date format YYYY-MM-DDTHH:mm:ss.SSSZ
The date needs to be in Zulu Time
e.g.
2013-07-01T17:00:00.000Z
...
O
...
ucdEdusMeta.authzId
...
String
...
Same as actor.author.id
...
R
...
ucdEdusModel
...
Object
...
...
R
...
ucdEdusModel.url
...
String
...
Activity content related URL
...
O
...
ucdEdusModel.urlDisplayName
...
String
...
Activity content related URL display name
...
O
...
ucdEdusModel.eventDate
...
String
...
Date the event will occur.
ISO-8601 Date format YYYY-MM-DDTHH:mm:ss.SSSZ
The date needs to be in Zulu Time
e.g.
2013-07-01T17:00:00.000Z
...
| Include Page | ||||
|---|---|---|---|---|
|
Sample request body containing the activity (JSON):
| Code Block | ||||
|---|---|---|---|---|
| ||||
{ "activity" : { "priority": 0.0, " "icon": "icon-comment-alt", "actor": { "id" : "department identifier", "objectType": "person", "displayName": "Department Name", "author" : { "id" : "kName", "displayName" : "FirstName LastName" } }, } }, "verb": "post", "title": "Test Notification", "object": { "id "ucdSrcId" : "content identifier", "objectType": "notification", "content": "This is a test notification" }, "to, "ucdEdusModel" : { "groups "url" : ["students"http://ucdavis.edu", "facultyurlDisplayName"], : "UC Davis" } "users }, "to" : [] { "id": "public", "g": true, "i": false } ], "ucdEdusMeta" : { "labels" : ["academic"~academic", "some-label"], "authzId" : "<Same as actor.author.id>", "startDate" : "date string", "endDate" : "date string" }, "ucdEdusModel" : { "url" : "", "urlDisplayName" : "" } } } }} |