| All Verbs | /api/activityfeed/{ObjectId} |
|---|
"use strict";
export class ActivityFeedModel {
/** @param {{ObjectId?:string,ActionEventId?:string,ObjectName?:string,ActionDescription?:string,OccurredDate?:string,AuditLevelId?:string,AuditLevelName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Object linked to the event. */
ObjectId;
/**
* @type {string}
* @description Event Id */
ActionEventId;
/**
* @type {string}
* @description Name of the object linked to the event. */
ObjectName;
/**
* @type {string}
* @description Event description */
ActionDescription;
/**
* @type {string}
* @description Date of occurence of the event. */
OccurredDate;
/**
* @type {string}
* @description User, system or triggered */
AuditLevelId;
/**
* @type {string}
* @description User, system or triggered */
AuditLevelName;
}
export class GetActivityFeedResponse {
/** @param {{ActivityFeed?:ActivityFeedModel[],TotalRecords?:number,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ActivityFeedModel[]} */
ActivityFeed;
/** @type {number} */
TotalRecords;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetActivityFeed {
/** @param {{ObjectId?:string,ActivityFeedType?:string[],IsPagedMode?:boolean,PageNumber?:number,PageSize?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Object to get activity feed for. */
ObjectId;
/**
* @type {string[]}
* @description User, system or triggered. */
ActivityFeedType;
/**
* @type {boolean}
* @description Return all feeds matching criteria or paged results? */
IsPagedMode;
/**
* @type {number}
* @description Return feeds matching criteria on the specified page number if paged mode. */
PageNumber;
/**
* @type {number}
* @description Number of feeds on each page if paged mode */
PageSize;
}
JavaScript GetActivityFeed DTOs
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>