| All Verbs | /api/activityfeed/{ObjectId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get activity feed related to the specified object.
*/
@Api(Description="Get activity feed related to the specified object.")
public static class GetActivityFeed
{
/**
* Object to get activity feed for.
*/
@ApiMember(Description="Object to get activity feed for.", IsRequired=true, Name="ObjectId")
public UUID ObjectId = null;
/**
* User, system or triggered.
*/
@ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")
public ArrayList<UUID> ActivityFeedType = null;
/**
* Return all feeds matching criteria or paged results?
*/
@ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")
public Boolean IsPagedMode = null;
/**
* Return feeds matching criteria on the specified page number if paged mode.
*/
@ApiMember(Description="Return feeds matching criteria on the specified page number if paged mode.", Name="PageNumber")
public Integer PageNumber = null;
/**
* Number of feeds on each page if paged mode
*/
@ApiMember(Description="Number of feeds on each page if paged mode", Name="PageSize")
public Integer PageSize = null;
public UUID getObjectId() { return ObjectId; }
public GetActivityFeed setObjectId(UUID value) { this.ObjectId = value; return this; }
public ArrayList<UUID> getActivityFeedType() { return ActivityFeedType; }
public GetActivityFeed setActivityFeedType(ArrayList<UUID> value) { this.ActivityFeedType = value; return this; }
public Boolean getIsPagedMode() { return IsPagedMode; }
public GetActivityFeed setIsPagedMode(Boolean value) { this.IsPagedMode = value; return this; }
public Integer getPageNumber() { return PageNumber; }
public GetActivityFeed setPageNumber(Integer value) { this.PageNumber = value; return this; }
public Integer getPageSize() { return PageSize; }
public GetActivityFeed setPageSize(Integer value) { this.PageSize = value; return this; }
}
@ApiResponse(Description="Activity feed related to the object.")
public static class GetActivityFeedResponse
{
public ArrayList<ActivityFeedModel> ActivityFeed = null;
public Integer TotalRecords = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<ActivityFeedModel> getActivityFeed() { return ActivityFeed; }
public GetActivityFeedResponse setActivityFeed(ArrayList<ActivityFeedModel> value) { this.ActivityFeed = value; return this; }
public Integer getTotalRecords() { return TotalRecords; }
public GetActivityFeedResponse setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetActivityFeedResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class ActivityFeedModel
{
/**
* Object linked to the event.
*/
@ApiMember(DataType="Guid", Description="Object linked to the event.", IsRequired=true, Name="ObjectId")
public UUID ObjectId = null;
/**
* Event Id
*/
@ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")
public UUID ActionEventId = null;
/**
* Name of the object linked to the event.
*/
@ApiMember(DataType="string", Description="Name of the object linked to the event.", Name="ObjectName")
public String ObjectName = null;
/**
* Event description
*/
@ApiMember(DataType="string", Description="Event description", Name="ActionDescription")
public String ActionDescription = null;
/**
* Date of occurence of the event.
*/
@ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")
public Date OccurredDate = null;
/**
* User, system or triggered
*/
@ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")
public UUID AuditLevelId = null;
/**
* User, system or triggered
*/
@ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")
public String AuditLevelName = null;
public UUID getObjectId() { return ObjectId; }
public ActivityFeedModel setObjectId(UUID value) { this.ObjectId = value; return this; }
public UUID getActionEventId() { return ActionEventId; }
public ActivityFeedModel setActionEventId(UUID value) { this.ActionEventId = value; return this; }
public String getObjectName() { return ObjectName; }
public ActivityFeedModel setObjectName(String value) { this.ObjectName = value; return this; }
public String getActionDescription() { return ActionDescription; }
public ActivityFeedModel setActionDescription(String value) { this.ActionDescription = value; return this; }
public Date getOccurredDate() { return OccurredDate; }
public ActivityFeedModel setOccurredDate(Date value) { this.OccurredDate = value; return this; }
public UUID getAuditLevelId() { return AuditLevelId; }
public ActivityFeedModel setAuditLevelId(UUID value) { this.AuditLevelId = value; return this; }
public String getAuditLevelName() { return AuditLevelName; }
public ActivityFeedModel setAuditLevelName(String value) { this.AuditLevelName = value; return this; }
}
}
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>