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

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 AutomatedAdjustmentTypeRequest
{

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

TypeScript AutomatedAdjustmentTypeRequest 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/type 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
		}
	]
}