| All Verbs | /api/updateobjectsubscription |
|---|
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 ObjectSubscription:
object_subscription_id: Optional[str] = None
object_id: Optional[str] = None
suite_data_source_instance_id: Optional[str] = None
rms_table_context_id: Optional[str] = None
alternate_key: Optional[str] = None
suite_data_source_name: Optional[str] = None
created_at: datetime.datetime = datetime.datetime(1, 1, 1)
last_modified: Optional[datetime.datetime] = None
record_status: Optional[str] = None
suite_instance_id: Optional[str] = None
suite_instance_name: Optional[str] = None
contact_id_licensee: Optional[str] = None
subscription_update_result_id: Optional[str] = None
subscription_update_result: Optional[str] = None
is_export: Optional[bool] = None
processed_at: Optional[datetime.datetime] = None
acknowledged_at: Optional[datetime.datetime] = None
failures: int = 0
result: Optional[str] = None
object_hash: Optional[str] = None
# @Api(Description="Updates an existing object subscription record")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateObjectSubscription:
"""
Updates an existing object subscription record
"""
object_subscription: Optional[ObjectSubscription] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObjectSubscriptionResponse:
success: bool = False
message: Optional[str] = None
response_status: Optional[ResponseStatus] = None
Python UpdateObjectSubscription DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/updateobjectsubscription HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ObjectSubscription":{"ObjectSubscriptionId":"00000000000000000000000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceInstanceId":"00000000-0000-0000-0000-000000000000","RmsTableContextId":"00000000-0000-0000-0000-000000000000","AlternateKey":"String","SuiteDataSourceName":"String","CreatedAt":"0001-01-01T00:00:00.0000000","LastModified":"0001-01-01T00:00:00.0000000","RecordStatus":"String","SuiteInstanceId":"00000000-0000-0000-0000-000000000000","SuiteInstanceName":"String","ContactIdLicensee":"00000000-0000-0000-0000-000000000000","SubscriptionUpdateResultId":"00000000000000000000000000000000","SubscriptionUpdateResult":"String","IsExport":false,"ProcessedAt":"0001-01-01T00:00:00.0000000","AcknowledgedAt":"0001-01-01T00:00:00.0000000","Failures":0,"Result":"String","ObjectHash":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Success":false,"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}