| All Verbs | /api/activityfeed/{ObjectId} |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ActivityFeedModel() =
///<summary>
///Object linked to the event.
///</summary>
[<ApiMember(DataType="Guid", Description="Object linked to the event.", IsRequired=true, Name="ObjectId")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///Event Id
///</summary>
[<ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")>]
member val ActionEventId:Guid = new Guid() with 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")>]
member val ObjectName:String = null with get,set
///<summary>
///Event description
///</summary>
[<ApiMember(DataType="string", Description="Event description", Name="ActionDescription")>]
member val ActionDescription:String = null with get,set
///<summary>
///Date of occurence of the event.
///</summary>
[<ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")>]
member val OccurredDate:DateTime = new DateTime() with get,set
///<summary>
///User, system or triggered
///</summary>
[<ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")>]
member val AuditLevelId:Guid = new Guid() with get,set
///<summary>
///User, system or triggered
///</summary>
[<ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")>]
member val AuditLevelName:String = null with get,set
[<ApiResponse(Description="Activity feed related to the object.")>]
[<AllowNullLiteral>]
type GetActivityFeedResponse() =
member val ActivityFeed:ResizeArray<ActivityFeedModel> = null with get,set
member val TotalRecords:Int32 = new Int32() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get activity feed related to the specified object.
///</summary>
[<Api(Description="Get activity feed related to the specified object.")>]
[<AllowNullLiteral>]
type GetActivityFeed() =
///<summary>
///Object to get activity feed for.
///</summary>
[<ApiMember(Description="Object to get activity feed for.", IsRequired=true, Name="ObjectId")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///User, system or triggered.
///</summary>
[<ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")>]
member val ActivityFeedType:ResizeArray<Guid> = null with get,set
///<summary>
///Return all feeds matching criteria or paged results?
///</summary>
[<ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")>]
member val IsPagedMode:Boolean = new Boolean() with 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")>]
member val PageNumber:Int32 = new Int32() with 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")>]
member val PageSize:Int32 = new Int32() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}