Platform Subscription API

<back to all web services

SaveContactRole

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RuleValidationResult:
    rule_code: Optional[str] = None
    message: Optional[str] = None
    key: Optional[str] = None
    tag: Optional[str] = None
    error_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidationErrorList:
    validation_errors: Optional[List[RuleValidationResult]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionContactRoleModel:
    # @ApiMember(DataType="string", Description="Name of the role.", Name="RoleName", ParameterType="query")
    role_name: Optional[str] = None
    """
    Name of the role.
    """


    # @ApiMember(DataType="string", Description="Short version of the role name.", Name="RoleShortName", ParameterType="query")
    role_short_name: Optional[str] = None
    """
    Short version of the role name.
    """


    # @ApiMember(DataType="string", Description="Description of the role purpose.", Name="RoleDescription", ParameterType="query")
    role_description: Optional[str] = None
    """
    Description of the role purpose.
    """


    # @ApiMember(DataType="bool", Description="If true, the role will be pending for a contact until they accept it.", Name="RequireContactsToAccept", ParameterType="query")
    require_contacts_to_accept: bool = False
    """
    If true, the role will be pending for a contact until they accept it.
    """


    # @ApiMember(DataType="List<Guid>", Description="Contact Types that may have this role.", Name="ContactTypes", ParameterType="query")
    contact_types: Optional[List[str]] = None
    """
    Contact Types that may have this role.
    """


    # @ApiMember(DataType="List<Guid>", Description="Role Filters this role should be added to.", Name="ListItemFilters", ParameterType="query")
    list_item_filters: Optional[List[str]] = None
    """
    Role Filters this role should be added to.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveContactRole(ValidationErrorList, ISubscription):
    # @ApiMember(DataType="Guid", Description="Guid representing the external systems data source information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    suite_data_source_instance_id: Optional[str] = None
    """
    Guid representing the external systems data source information.
    """


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


    # @ApiMember(DataType="Guid", Description="Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")
    object_id: Optional[str] = None
    """
    Guid of the contact role object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
    """


    # @ApiMember(DataType="SubscriptionContactRoleModel", Description="Object containing all details of the contact role to be inserted or updated.", IsRequired=true, Name="ContactRole", ParameterType="query")
    contact_role: Optional[SubscriptionContactRoleModel] = None
    """
    Object containing all details of the contact role to be inserted or updated.
    """


    ignore_validation: bool = False

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

{
	AlternateKey: String,
	ContactRole: 
	{
		RoleName: String,
		RoleShortName: String,
		RoleDescription: String,
		RequireContactsToAccept: False,
		ContactTypes: 
		[
			00000000-0000-0000-0000-000000000000
		],
		ListItemFilters: 
		[
			00000000-0000-0000-0000-000000000000
		]
	},
	IgnoreValidation: False,
	ValidationErrors: 
	[
		{
			RuleCode: String,
			Message: String,
			Key: String,
			Tag: String,
			ErrorCode: String
		}
	]
}
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
	}
}