Platform API

<back to all web services

GetActivityFeed

Get activity feed related to the specified object.

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ActivityFeedModel:
    # @ApiMember(DataType="Guid", Description="Object linked to the event.", IsRequired=true, Name="ObjectId")
    object_id: Optional[str] = None
    """
    Object linked to the event.
    """


    # @ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")
    action_event_id: Optional[str] = None
    """
    Event Id
    """


    # @ApiMember(DataType="string", Description="Name of the object linked to the event.", Name="ObjectName")
    object_name: Optional[str] = None
    """
    Name of the object linked to the event.
    """


    # @ApiMember(DataType="string", Description="Event description", Name="ActionDescription")
    action_description: Optional[str] = None
    """
    Event description
    """


    # @ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")
    occurred_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Date of occurence of the event.
    """


    # @ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")
    audit_level_id: Optional[str] = None
    """
    User, system or triggered
    """


    # @ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")
    audit_level_name: Optional[str] = None
    """
    User, system or triggered
    """


# @ApiResponse(Description="Activity feed related to the object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetActivityFeedResponse:
    activity_feed: Optional[List[ActivityFeedModel]] = None
    total_records: int = 0
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Get activity feed related to the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetActivityFeed:
    """
    Get activity feed related to the specified object.
    """

    # @ApiMember(Description="Object to get activity feed for.", IsRequired=true, Name="ObjectId")
    object_id: Optional[str] = None
    """
    Object to get activity feed for.
    """


    # @ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")
    activity_feed_type: Optional[List[str]] = None
    """
    User, system or triggered.
    """


    # @ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")
    is_paged_mode: bool = False
    """
    Return all feeds matching criteria or paged results?
    """


    # @ApiMember(Description="Return feeds matching criteria on the specified page number if paged mode.", Name="PageNumber")
    page_number: int = 0
    """
    Return feeds matching criteria on the specified page number if paged mode.
    """


    # @ApiMember(Description="Number of feeds on each page if paged mode", Name="PageSize")
    page_size: int = 0
    """
    Number of feeds on each page if paged mode
    """

Python 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>