Platform API

<back to all web services

GetActivityFeed

Get activity feed related to the specified object.

export class ActivityFeedModel
{
    /** @description Object linked to the event. */
    // @ApiMember(DataType="Guid", Description="Object linked to the event.", IsRequired=true, Name="ObjectId")
    public ObjectId: string;

    /** @description Event Id */
    // @ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")
    public ActionEventId: string;

    /** @description Name of the object linked to the event. */
    // @ApiMember(DataType="string", Description="Name of the object linked to the event.", Name="ObjectName")
    public ObjectName: string;

    /** @description Event description */
    // @ApiMember(DataType="string", Description="Event description", Name="ActionDescription")
    public ActionDescription: string;

    /** @description Date of occurence of the event. */
    // @ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")
    public OccurredDate: string;

    /** @description User, system or triggered */
    // @ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")
    public AuditLevelId: string;

    /** @description User, system or triggered */
    // @ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")
    public AuditLevelName: string;

    public constructor(init?: Partial<ActivityFeedModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="Activity feed related to the object.")
export class GetActivityFeedResponse
{
    public ActivityFeed: ActivityFeedModel[];
    public TotalRecords: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetActivityFeedResponse>) { (Object as any).assign(this, init); }
}

/** @description Get activity feed related to the specified object. */
// @Api(Description="Get activity feed related to the specified object.")
export class GetActivityFeed
{
    /** @description Object to get activity feed for. */
    // @ApiMember(Description="Object to get activity feed for.", IsRequired=true, Name="ObjectId")
    public ObjectId: string;

    /** @description User, system or triggered. */
    // @ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")
    public ActivityFeedType: string[];

    /** @description Return all feeds matching criteria or paged results? */
    // @ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")
    public IsPagedMode: boolean;

    /** @description 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 PageNumber: number;

    /** @description Number of feeds on each page if paged mode */
    // @ApiMember(Description="Number of feeds on each page if paged mode", Name="PageSize")
    public PageSize: number;

    public constructor(init?: Partial<GetActivityFeed>) { (Object as any).assign(this, init); }
}

TypeScript GetActivityFeed DTOs

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>