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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AutomatedAdjustment() = 
        member val AutomatedAdustmentId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val FromAgentId:Int32 = new Int32() with get,set
        member val ToAgentId:String = null with get,set
        member val ToAgentName:String = null with get,set
        member val Description:String = null with get,set
        member val TypeId:Int32 = new Int32() with get,set
        member val TypeDescription:String = null with get,set
        member val FrequencyId:Int32 = new Int32() with get,set
        member val FrequencyDescription:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ChargeCount:Int32 = new Int32() with get,set
        member val ChargeSum:Decimal = new Decimal() with get,set
        member val Installments:Int32 = new Int32() with get,set
        member val PauseUntil:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val CreatedBy:String = null with get,set
        member val ModifiedBy:String = null with get,set
        member val FirstCommissionRequired:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type AutomatedAdjustmentType() = 
        member val AutomatedAdjustmentTypeId:Int32 = new Int32() with get,set
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type AutomatedAdjustmentfrequency() = 
        member val AutomatedAdjustmentFrequencyId:Int32 = new Int32() with get,set
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type AutomatedAdjustmentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val AutomatedAdjustments:ResizeArray<AutomatedAdjustment> = new ResizeArray<AutomatedAdjustment>() with get,set
        member val AutomatedAdjustment:AutomatedAdjustment = null with get,set
        member val AutomatedAdjustmentID:Int32 = new Int32() with get,set
        member val AutomatedAdjustmentTypes:ResizeArray<AutomatedAdjustmentType> = new ResizeArray<AutomatedAdjustmentType>() with get,set
        member val AutomatedAdjustmentFrequencies:ResizeArray<AutomatedAdjustmentfrequency> = new ResizeArray<AutomatedAdjustmentfrequency>() with get,set

    [<AllowNullLiteral>]
    type AutomatedAdjustmentFrequencyRequest() = 
        class end

F# 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
		}
	]
}