Platform API

UpdateObjectSubscrptionStatus

Updates an object subscription status

The following routes are available for this service:
All Verbs	/api/updateobjectsubscriptionstatus

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 ListItemFilter:
    list_item_filter_id: Optional[str] = None
    filter_name: Optional[str] = None
    list_id: Optional[str] = None
    list_item_id: Optional[str] = None
    list_item_is_in_filter: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListDataItem:
    id: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    short_name: Optional[str] = None
    default_name: Optional[str] = None
    is_default: bool = False
    order: int = 0
    list_item_traffic_light_id: Optional[str] = None
    primary_list_item_image_id: Optional[str] = None
    primary_list_item_image_url: Optional[str] = None
    primary_image_thumbnail_url: Optional[str] = None
    owner_contact_id: Optional[str] = None
    record_status: Optional[str] = None
    tags: Optional[str] = None
    list_id: Optional[str] = None
    mark_as_checked: bool = False
    related_object_id: Optional[str] = None
    can_edit: bool = False
    is_owner: bool = False
    extra_values: Optional[List[Object]] = None
    list_item_filters: Optional[List[ListItemFilter]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDataSourcesResponse:
    data_sources: Optional[List[ListDataItem]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Updates an object subscription status")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateObjectSubscrptionStatus:
    """
    Updates an object subscription status
    """

    object_subscription_id: Optional[str] = None
    record_status: Optional[str] = None
    subscription_key: Optional[str] = None

Python UpdateObjectSubscrptionStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/updateobjectsubscriptionstatus HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RecordStatus: ,
	SubscriptionKey: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DataSources: 
	[
		{
			Name: String,
			Description: String,
			ShortName: String,
			DefaultName: String,
			IsDefault: False,
			Order: 0,
			PrimaryListItemImageUrl: String,
			PrimaryImageThumbnailUrl: String,
			RecordStatus: String,
			Tags: String,
			MarkAsChecked: False,
			CanEdit: False,
			IsOwner: False,
			ExtraValues: 
			[
				{
					
				}
			],
			ListItemFilters: 
			[
				{
					FilterName: String,
					ListItemIsInFilter: False
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}