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}
import Foundation
import ServiceStack

public class AdjustmentRequest : Codable
{
    public var adjustment:[Adjustment] = []
    public var agentID:Int
    public var paramStartDate:Date
    public var paramEndDate:Date

    required public init(){}
}

public class Adjustment : Codable
{
    public var id:Int
    public var adjustmentDate:Date
    public var agent:String
    public var reason:String
    public var amount:Double
    public var approved:String
    public var adjType:String
    public var income:String
    public var paid:String
    public var balanceForward:String
    public var balanceDate:String

    required public init(){}
}

public class AdjustmentResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var adjustment:[Adjustment] = []

    required public init(){}
}


Swift 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
		}
	]
}