Platform Subscription API

<back to all web services

SaveObjectSubscription

Inserts an object subscription for an integrated object.

Requires Authentication
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


# @Api(Description="Inserts an object subscription for an integrated object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveObjectSubscription(ISubscription):
    """
    Inserts an object subscription for an integrated object.
    """

    # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")
    suite_data_source_instance_id: Optional[str] = None
    """
    Guid representing the external systems datasource information.
    """


    # @ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey")
    alternate_key: Optional[str] = None
    """
    The unique key that represents the object on the external system.
    """


    # @ApiMember(DataType="Guid", Description="Guid of the object within Eros.", IsRequired=true, Name="ObjectId")
    object_id: Optional[str] = None
    """
    Guid of the object within Eros.
    """


    # @ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.", IsRequired=true, Name="RmsTableCtxId")
    rms_table_ctx_id: Optional[str] = None
    """
    Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.
    """


    ignore_validation: bool = False

Python SaveObjectSubscription 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 /jsv/reply/SaveObjectSubscription HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AlternateKey: String,
	IgnoreValidation: True
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	}
}