Trendsic Platform Service

<back to all web services

AdjustmentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Adjustment/{ID}
GET,POST,PUT,DELETE,OPTIONS/v1/Adjustment
GET,POST,PUT,DELETE,OPTIONS/v1/Adjustment/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,POST,PUT,DELETE,OPTIONS/v1/Adjustment/DateRange/{ParamStartDate}/{ParamEndDate}
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 Adjustment() = 
        member val ID:Int32 = new Int32() with get,set
        member val AdjustmentDate:DateTime = new DateTime() with get,set
        member val Agent:String = null with get,set
        member val Reason:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Approved:String = null with get,set
        member val AdjType:String = null with get,set
        member val Income:String = null with get,set
        member val Paid:String = null with get,set
        member val BalanceForward:String = null with get,set
        member val BalanceDate:String = null with get,set

    [<AllowNullLiteral>]
    type AdjustmentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Adjustment:ResizeArray<Adjustment> = new ResizeArray<Adjustment>() with get,set

    [<AllowNullLiteral>]
    type AdjustmentRequest() = 
        member val Adjustment:ResizeArray<Adjustment> = new ResizeArray<Adjustment>() with get,set
        member val AgentID:Int32 = new Int32() with get,set
        member val ParamStartDate:DateTime = new DateTime() with get,set
        member val ParamEndDate:DateTime = new DateTime() with get,set

F# AdjustmentRequest 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.

POST /v1/Adjustment/{ID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Adjustment: 
	[
		{
			ID: 0,
			AdjustmentDate: 0001-01-01,
			Agent: String,
			Reason: String,
			Amount: 0,
			Approved: String,
			AdjType: String,
			Income: String,
			Paid: String,
			BalanceForward: String,
			BalanceDate: String
		}
	],
	AgentID: 0,
	ParamStartDate: 0001-01-01,
	ParamEndDate: 0001-01-01
}
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
		}
	},
	Adjustment: 
	[
		{
			ID: 0,
			AdjustmentDate: 0001-01-01,
			Agent: String,
			Reason: String,
			Amount: 0,
			Approved: String,
			AdjType: String,
			Income: String,
			Paid: String,
			BalanceForward: String,
			BalanceDate: String
		}
	]
}