Trendsic Platform Service

<back to all web services

AutomatedAdjustmentTypeRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/AutomatedAdjustment/type
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 AutomatedAdjustmentTypeRequest:
    pass

Python AutomatedAdjustmentTypeRequest DTOs

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

HTTP + XML

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

GET /v1/AutomatedAdjustment/type HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AutomatedAdjustmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AutomatedAdjustment>
    <Amount>0</Amount>
    <AutomatedAdustmentId>0</AutomatedAdustmentId>
    <ChargeCount>0</ChargeCount>
    <ChargeSum>0</ChargeSum>
    <CreatedBy>String</CreatedBy>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <Description>String</Description>
    <FirstCommissionRequired>false</FirstCommissionRequired>
    <FrequencyDescription>String</FrequencyDescription>
    <FrequencyId>0</FrequencyId>
    <FromAgentId>0</FromAgentId>
    <Installments>0</Installments>
    <ModifiedBy>String</ModifiedBy>
    <Name>String</Name>
    <PauseUntil>0001-01-01T00:00:00</PauseUntil>
    <ToAgentId>0</ToAgentId>
    <ToAgentName>String</ToAgentName>
    <TypeDescription>String</TypeDescription>
    <TypeId>0</TypeId>
  </AutomatedAdjustment>
  <AutomatedAdjustmentFrequencies>
    <AutomatedAdjustmentfrequency>
      <AutomatedAdjustmentFrequencyId>0</AutomatedAdjustmentFrequencyId>
      <Description>String</Description>
    </AutomatedAdjustmentfrequency>
  </AutomatedAdjustmentFrequencies>
  <AutomatedAdjustmentID>0</AutomatedAdjustmentID>
  <AutomatedAdjustmentTypes>
    <AutomatedAdjustmentType>
      <AutomatedAdjustmentTypeId>0</AutomatedAdjustmentTypeId>
      <Description>String</Description>
    </AutomatedAdjustmentType>
  </AutomatedAdjustmentTypes>
  <AutomatedAdjustments>
    <AutomatedAdjustment>
      <Amount>0</Amount>
      <AutomatedAdustmentId>0</AutomatedAdustmentId>
      <ChargeCount>0</ChargeCount>
      <ChargeSum>0</ChargeSum>
      <CreatedBy>String</CreatedBy>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <Description>String</Description>
      <FirstCommissionRequired>false</FirstCommissionRequired>
      <FrequencyDescription>String</FrequencyDescription>
      <FrequencyId>0</FrequencyId>
      <FromAgentId>0</FromAgentId>
      <Installments>0</Installments>
      <ModifiedBy>String</ModifiedBy>
      <Name>String</Name>
      <PauseUntil>0001-01-01T00:00:00</PauseUntil>
      <ToAgentId>0</ToAgentId>
      <ToAgentName>String</ToAgentName>
      <TypeDescription>String</TypeDescription>
      <TypeId>0</TypeId>
    </AutomatedAdjustment>
  </AutomatedAdjustments>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AutomatedAdjustmentResponse>