Platform API

<back to all web services

GetActivityFeed

Get activity feed related to the specified object.

Requires Authentication
The following routes are available for this service:
All Verbs/api/activityfeed/{ObjectId}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

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 virtual Guid ObjectId { get; set; }

        ///<summary>
        ///Event Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")]
        public virtual Guid ActionEventId { get; set; }

        ///<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 virtual string ObjectName { get; set; }

        ///<summary>
        ///Event description
        ///</summary>
        [ApiMember(DataType="string", Description="Event description", Name="ActionDescription")]
        public virtual string ActionDescription { get; set; }

        ///<summary>
        ///Date of occurence of the event.
        ///</summary>
        [ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")]
        public virtual DateTime OccurredDate { get; set; }

        ///<summary>
        ///User, system or triggered
        ///</summary>
        [ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")]
        public virtual Guid AuditLevelId { get; set; }

        ///<summary>
        ///User, system or triggered
        ///</summary>
        [ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")]
        public virtual string AuditLevelName { get; set; }
    }

}

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 virtual Guid ObjectId { get; set; }

        ///<summary>
        ///User, system or triggered.
        ///</summary>
        [ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")]
        public virtual List<Guid> ActivityFeedType { get; set; }

        ///<summary>
        ///Return all feeds matching criteria or paged results?
        ///</summary>
        [ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")]
        public virtual bool IsPagedMode { get; set; }

        ///<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 virtual int PageNumber { get; set; }

        ///<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 virtual int PageSize { get; set; }
    }

    [ApiResponse(Description="Activity feed related to the object.")]
    public partial class GetActivityFeedResponse
    {
        public virtual List<ActivityFeedModel> ActivityFeed { get; set; }
        public virtual int TotalRecords { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetActivityFeed DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ActivityFeedType: 
	[
		00000000-0000-0000-0000-000000000000
	],
	IsPagedMode: False,
	PageNumber: 0,
	PageSize: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ActivityFeed: 
	[
		{
			ObjectName: String,
			ActionDescription: String,
			OccurredDate: 0001-01-01,
			AuditLevelName: String
		}
	],
	TotalRecords: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}