Platform API

<back to all web services

GetObjectSubscriptions

Get object subscriptions for 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 ObjectSubscriptionDetailModel:
    # @ApiMember(Description="ID for the objectSubscription record.", Name="ObjectSubscriptionId")
    object_subscription_id: Optional[str] = None
    """
    ID for the objectSubscription record.
    """


    # @ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")
    suite_data_source_instance_id: Optional[str] = None
    """
    Id of the Suite DataSource Instance Id.
    """


    # @ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")
    suite_data_source_name: Optional[str] = None
    """
    Suite DataSource Instance Name.
    """


    # @ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")
    rms_table_context_id: Optional[str] = None
    """
    Id indicating the RmsTableCtx of the object.
    """


    # @ApiMember(Description="Id of the integrated object.", Name="ObjectId")
    object_id: Optional[str] = None
    """
    Id of the integrated object.
    """


    # @ApiMember(Description="Unique Key of this object in the external Data Source.", Name="AlternateKey")
    alternate_key: Optional[str] = None
    """
    Unique Key of this object in the external Data Source.
    """


    # @ApiMember(Description="Date the object was integrated.", Name="CreatedAt")
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Date the object was integrated.
    """


    # @ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")
    record_status: Optional[str] = None
    """
    Record Status of the object subscription.
    """


    # @ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")
    suite_instance_id: Optional[str] = None
    """
    Id of the Suite Instance.
    """


    # @ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")
    suite_instance_name: Optional[str] = None
    """
    Suite Instance Name.
    """


# @ApiResponse(Description="List of object subscriptions")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectSubscriptionsResponse:
    object_subscriptions: Optional[List[ObjectSubscriptionDetailModel]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Get object subscriptions for the specified object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectSubscriptions:
    """
    Get object subscriptions for the specified object
    """

    # @ApiMember(Description="Get active/inactive object subscriptions for the specified object", IsRequired=true, Name="ObjectId")
    object_id: Optional[str] = None
    """
    Get active/inactive object subscriptions for the specified object
    """

Python GetObjectSubscriptions DTOs

POST /api/objectsubscriptions/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetObjectSubscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
</GetObjectSubscriptions>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetObjectSubscriptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectSubscriptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:ObjectSubscriptionDetailModel>
      <d2p1:AlternateKey>String</d2p1:AlternateKey>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
      <d2p1:ObjectSubscriptionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectSubscriptionId>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:RmsTableContextId>00000000-0000-0000-0000-000000000000</d2p1:RmsTableContextId>
      <d2p1:SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteDataSourceInstanceId>
      <d2p1:SuiteDataSourceName>String</d2p1:SuiteDataSourceName>
      <d2p1:SuiteInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteInstanceId>
      <d2p1:SuiteInstanceName>String</d2p1:SuiteInstanceName>
    </d2p1:ObjectSubscriptionDetailModel>
  </ObjectSubscriptions>
  <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>
</GetObjectSubscriptionsResponse>