Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.ucdSrcId

String

Unique Source Content ID

R

object.objectType

String

Use "notification"

R

object.content

String

Activity content (Text)

R

object.ucdEdusModel

Object

 

R

object.ucdEdusModel.url

String

Activity content related URL

O

object.ucdEdusModel.urlDisplayName

String

Activity content related URL display name

O

object.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

O

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~academic", "~student-life", "campus-life~campus-life", "~campus-messages"] 
Additional labels that don't have a tilda '~' prefix are allowed.
e.g.
 ["~academic", "hold", "financial-aid"]

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

...