Trendsic Platform Service

<back to all web services

AutomatedAdjustmentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET, OPTIONS/v1/AutomatedAdjustment/{AutomatedAdjustmentID}
DELETE/v1/AutomatedAdjustment/{AutomatedAdjustmentID}
GET, POST, PUT, DELETE, OPTIONS/v1/AutomatedAdjustment

export class AutomatedAdjustment
{
    public AutomatedAdustmentId: number;
    public Name: string;
    public FromAgentId: number;
    public ToAgentId: string;
    public ToAgentName: string;
    public Description: string;
    public TypeId: number;
    public TypeDescription: string;
    public FrequencyId: number;
    public FrequencyDescription: string;
    public Amount: number;
    public ChargeCount: number;
    public ChargeSum: number;
    public Installments: number;
    public PauseUntil?: string;
    public DateCreated: string;
    public CreatedBy: string;
    public ModifiedBy: string;
    public FirstCommissionRequired: boolean;

    public constructor(init?: Partial<AutomatedAdjustment>) { (Object as any).assign(this, init); }
}

export class AutomatedAdjustmentType
{
    public AutomatedAdjustmentTypeId: number;
    public Description: string;

    public constructor(init?: Partial<AutomatedAdjustmentType>) { (Object as any).assign(this, init); }
}

export class AutomatedAdjustmentfrequency
{
    public AutomatedAdjustmentFrequencyId: number;
    public Description: string;

    public constructor(init?: Partial<AutomatedAdjustmentfrequency>) { (Object as any).assign(this, init); }
}

export class AutomatedAdjustmentResponse
{
    public ResponseStatus: ResponseStatus;
    public AutomatedAdjustments: AutomatedAdjustment[] = [];
    public AutomatedAdjustment: AutomatedAdjustment;
    public AutomatedAdjustmentID: number;
    public AutomatedAdjustmentTypes: AutomatedAdjustmentType[] = [];
    public AutomatedAdjustmentFrequencies: AutomatedAdjustmentfrequency[] = [];

    public constructor(init?: Partial<AutomatedAdjustmentResponse>) { (Object as any).assign(this, init); }
}

export class AutomatedAdjustmentRequest
{
    public AutomatedAdjustments: AutomatedAdjustment[] = [];
    public AutomatedAdjustment: AutomatedAdjustment;
    public AutomatedAdjustmentID: number;

    public constructor(init?: Partial<AutomatedAdjustmentRequest>) { (Object as any).assign(this, init); }
}

TypeScript AutomatedAdjustmentRequest 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.

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

<AutomatedAdjustmentRequest 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>
  <AutomatedAdjustmentID>0</AutomatedAdjustmentID>
  <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>
</AutomatedAdjustmentRequest>
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>