Platform API

GetActivityFeed

Get activity feed related to the specified object.

The following routes are available for this service:
All Verbs	/api/activityfeed/{ObjectId}

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.Models

        Public Partial Class ActivityFeedModel
            '''<Summary>
            '''Object linked to the event.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Object linked to the event.", IsRequired:=true, Name:="ObjectId")>
            Public Overridable Property ObjectId As Guid

            '''<Summary>
            '''Event Id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Event Id", IsRequired:=true, Name:="ActionEventId")>
            Public Overridable Property ActionEventId As Guid

            '''<Summary>
            '''Name of the object linked to the event.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Name of the object linked to the event.", Name:="ObjectName")>
            Public Overridable Property ObjectName As String

            '''<Summary>
            '''Event description
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Event description", Name:="ActionDescription")>
            Public Overridable Property ActionDescription As String

            '''<Summary>
            '''Date of occurence of the event.
            '''</Summary>
            <ApiMember(DataType:="DateTime", Description:="Date of occurence of the event.", IsRequired:=true, Name:="OccurredDate")>
            Public Overridable Property OccurredDate As Date

            '''<Summary>
            '''User, system or triggered
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="User, system or triggered", Name:="AuditLevelId")>
            Public Overridable Property AuditLevelId As Guid

            '''<Summary>
            '''User, system or triggered
            '''</Summary>
            <ApiMember(DataType:="string", Description:="User, system or triggered", Name:="AuditLevelName")>
            Public Overridable Property AuditLevelName As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get activity feed related to the specified object.
        '''</Summary>
        <Api(Description:="Get activity feed related to the specified object.")>
        Public Partial Class GetActivityFeed
            '''<Summary>
            '''Object to get activity feed for.
            '''</Summary>
            <ApiMember(Description:="Object to get activity feed for.", IsRequired:=true, Name:="ObjectId")>
            Public Overridable Property ObjectId As Guid

            '''<Summary>
            '''User, system or triggered.
            '''</Summary>
            <ApiMember(Description:="User, system or triggered.", Name:="ActivityFeedType")>
            Public Overridable Property ActivityFeedType As List(Of Guid)

            '''<Summary>
            '''Return all feeds matching criteria or paged results?
            '''</Summary>
            <ApiMember(Description:="Return all feeds matching criteria or paged results?", Name:="IsPagedMode")>
            Public Overridable Property IsPagedMode As Boolean

            '''<Summary>
            '''Return feeds matching criteria on the specified page number if paged mode.
            '''</Summary>
            <ApiMember(Description:="Return feeds matching criteria on the specified page number if paged mode.", Name:="PageNumber")>
            Public Overridable Property PageNumber As Integer

            '''<Summary>
            '''Number of feeds on each page if paged mode
            '''</Summary>
            <ApiMember(Description:="Number of feeds on each page if paged mode", Name:="PageSize")>
            Public Overridable Property PageSize As Integer
        End Class

        <ApiResponse(Description:="Activity feed related to the object.")>
        Public Partial Class GetActivityFeedResponse
            Public Overridable Property ActivityFeed As List(Of ActivityFeedModel)
            Public Overridable Property TotalRecords As Integer
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetActivityFeed DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/activityfeed/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000","ActivityFeedType":["00000000-0000-0000-0000-000000000000"],"IsPagedMode":false,"PageNumber":0,"PageSize":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ActivityFeed":[{"ObjectId":"00000000-0000-0000-0000-000000000000","ActionEventId":"00000000-0000-0000-0000-000000000000","ObjectName":"String","ActionDescription":"String","OccurredDate":"0001-01-01T00:00:00.0000000","AuditLevelId":"00000000-0000-0000-0000-000000000000","AuditLevelName":"String"}],"TotalRecords":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}