| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<GetActivityFeed xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ActivityFeedType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ActivityFeedType>
<IsPagedMode>false</IsPagedMode>
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
<PageNumber>0</PageNumber>
<PageSize>0</PageSize>
</GetActivityFeed>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetActivityFeedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ActivityFeed xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ActivityFeedModel>
<d2p1:ActionDescription>String</d2p1:ActionDescription>
<d2p1:ActionEventId>00000000-0000-0000-0000-000000000000</d2p1:ActionEventId>
<d2p1:AuditLevelId>00000000-0000-0000-0000-000000000000</d2p1:AuditLevelId>
<d2p1:AuditLevelName>String</d2p1:AuditLevelName>
<d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
<d2p1:ObjectName>String</d2p1:ObjectName>
<d2p1:OccurredDate>0001-01-01T00:00:00</d2p1:OccurredDate>
</d2p1:ActivityFeedModel>
</ActivityFeed>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<TotalRecords>0</TotalRecords>
</GetActivityFeedResponse>