| All Verbs | /api/activityfeed/{ObjectId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | path | Guid | Yes | Object to get activity feed for. |
| ActivityFeedType | query | List<Guid> | No | User, system or triggered. |
| IsPagedMode | query | bool | No | Return all feeds matching criteria or paged results? |
| PageNumber | query | int | No | Return feeds matching criteria on the specified page number if paged mode. |
| PageSize | query | int | No | Number of feeds on each page if paged mode |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ActivityFeed | form | List<ActivityFeedModel> | No | |
| TotalRecords | form | int | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | form | Guid | Yes | Object linked to the event. |
| ActionEventId | form | Guid | Yes | Event Id |
| ObjectName | form | string | No | Name of the object linked to the event. |
| ActionDescription | form | string | No | Event description |
| OccurredDate | form | DateTime | Yes | Date of occurence of the event. |
| AuditLevelId | form | Guid | No | User, system or triggered |
| AuditLevelName | form | string | No | User, system or triggered |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"ObjectId":"00000000-0000-0000-0000-000000000000","ActivityFeedType":["00000000-0000-0000-0000-000000000000"],"IsPagedMode":false,"PageNumber":0,"PageSize":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ActivityFeed":[{"ObjectId":"00000000-0000-0000-0000-000000000000","ActionEventId":"00000000-0000-0000-0000-000000000000","ObjectName":"String","ActionDescription":"String","OccurredDate":"0001-01-01T00:00:00.0000000","AuditLevelId":"00000000-0000-0000-0000-000000000000","AuditLevelName":"String"}],"TotalRecords":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}