Trendsic Platform Service

<back to all web services

AutomatedAdjustmentFrequencyRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/AutomatedAdjustment/frequency
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 AutomatedAdjustment:
    automated_adustment_id: int = 0
    name: Optional[str] = None
    from_agent_id: int = 0
    to_agent_id: Optional[str] = None
    to_agent_name: Optional[str] = None
    description: Optional[str] = None
    type_id: int = 0
    type_description: Optional[str] = None
    frequency_id: int = 0
    frequency_description: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    charge_count: int = 0
    charge_sum: Decimal = decimal.Decimal(0)
    installments: int = 0
    pause_until: Optional[datetime.datetime] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by: Optional[str] = None
    modified_by: Optional[str] = None
    first_commission_required: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutomatedAdjustmentType:
    automated_adjustment_type_id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutomatedAdjustmentfrequency:
    automated_adjustment_frequency_id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutomatedAdjustmentResponse:
    response_status: Optional[ResponseStatus] = None
    automated_adjustments: List[AutomatedAdjustment] = field(default_factory=list)
    automated_adjustment: Optional[AutomatedAdjustment] = None
    automated_adjustment_i_d: int = 0
    automated_adjustment_types: List[AutomatedAdjustmentType] = field(default_factory=list)
    automated_adjustment_frequencies: List[AutomatedAdjustmentfrequency] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutomatedAdjustmentFrequencyRequest:
    pass

Python AutomatedAdjustmentFrequencyRequest 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.

GET /v1/AutomatedAdjustment/frequency HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	AutomatedAdjustments: 
	[
		{
			AutomatedAdustmentId: 0,
			Name: String,
			FromAgentId: 0,
			ToAgentId: 0,
			ToAgentName: String,
			Description: String,
			TypeId: 0,
			TypeDescription: String,
			FrequencyId: 0,
			FrequencyDescription: String,
			Amount: 0,
			ChargeCount: 0,
			ChargeSum: 0,
			Installments: 0,
			PauseUntil: 0001-01-01,
			DateCreated: 0001-01-01,
			CreatedBy: String,
			ModifiedBy: String,
			FirstCommissionRequired: False
		}
	],
	AutomatedAdjustment: 
	{
		AutomatedAdustmentId: 0,
		Name: String,
		FromAgentId: 0,
		ToAgentId: 0,
		ToAgentName: String,
		Description: String,
		TypeId: 0,
		TypeDescription: String,
		FrequencyId: 0,
		FrequencyDescription: String,
		Amount: 0,
		ChargeCount: 0,
		ChargeSum: 0,
		Installments: 0,
		PauseUntil: 0001-01-01,
		DateCreated: 0001-01-01,
		CreatedBy: String,
		ModifiedBy: String,
		FirstCommissionRequired: False
	},
	AutomatedAdjustmentID: 0,
	AutomatedAdjustmentTypes: 
	[
		{
			AutomatedAdjustmentTypeId: 0,
			Description: String
		}
	],
	AutomatedAdjustmentFrequencies: 
	[
		{
			AutomatedAdjustmentFrequencyId: 0,
			Description: String
		}
	]
}