Sources API
Source Data Model
ISO-8601 Date format YYYY-MM-DDTHH:mm:ss.SSSZ
Key | Type | Comment | Required (R) or Optional (O) |
|---|---|---|---|
activityTypes | Array of activityType Objects | [{
"id": "event",
"name": "Event",
"icon": "/content/logos/mondavi.png"
},
{
"id": "notification",
"name": "Notification",
"icon": "/content/logos/mondavi.png"
}] | R |
approveBy | Number | Number of approvers required for any post that is manually created | R |
approvers | Array | Array of strings, where each entry is the kerberos id of the user granted the ability to approve posts | R |
canSendTo | Array | Array of objects, where each entry represents a group that is addressable by this source. e.g. [
{
"id": "public",
"name": "Public"
},
{
"id": "students",
"name": "All Students"
},
{
"id": "staff",
"name": "All Staff"
},
{
"id": "faculty",
"name": "All Faculty"
}
]
| R |
creators | Array | Array of strings, where each entry is the kerberos id of the user granted the ability to create posts | R |
isRequired | Boolean | Indicating if a user can unsubscribe from this source | R |
notification | Boolean | Send email to approvers if a new posts was created that needs approvals | R |
sourceId | String | UUID | R |
sourceName | String | Unique source name | R |
sourceLabel | Object | Default label. One of campus-life, campus-messages, academic, student-life, faculty, staff {
"id": "~campus-life",
"name": "Campus-Life"
}
| R |
autosubscribe | Boolean | Indicating if this source is added to a user's subscriptions list by default | R |
connections | Array | Array of External Connections (i.e. Facebook pages/groups, Campus Calendars, etc.) NOTE: This is not implemented yet | O |
sourceDescription | String | Descriptions of what the source is about. | R |
sourceSlug | String | This is used by the aggiefeed landing page e.g. https://aggiefeed.ucdavis.edu/posts/<sourceSlug> | R |
sourceOwner | String | Source owner's loginId (kerberos id) | R |
sourceCreationDate | String | ISO-8601 Date format YYYY-MM-DDTHH:mm:ss.SSSZ | R |
sourceStats | Object |
| O |
sourceStats.postCount | Number | Number of posts created by source | O |
sourceStats.subscriberCount | Number | Number of users that are subscribed to this source | O |
sourceStats.latestPostCreationDate | String | ISO-8601 Date format YYYY-MM-DDTHH:mm:ss.SSSZ | O |
ActivityType
Key | Type | Comment | Required (R) or Optional (O) |
|---|---|---|---|
id | String | "event" or "notification" | R |
name | String | "Event" or "Notification" | R |
icon | String | Image location or icon name | R |
color | String | If "icon" is an "icon name" then an optional color HEX value can be used. #82f0ff | O |
Connection