Trendsic Platform Service

AgreementKpiRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dashboard/agreements

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class AgreementKpiRequest
{
    open var FromDate:Date? = null
    open var ToDate:Date? = null
    open var LocationIds:ArrayList<UUID> = ArrayList<UUID>()
}

open class AgreementKpiResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Stats:ArrayList<DashboardStatTile> = ArrayList<DashboardStatTile>()
    open var ByBranch:ArrayList<AgreementKpiBranchRow> = ArrayList<AgreementKpiBranchRow>()
}

open class DashboardStatTile
{
    open var Key:String? = null
    open var Label:String? = null
    open var Value:Double? = null
    open var PreviousValue:Double? = null
    open var Unit:String? = null
    open var DeltaPct:Double? = null
}

open class AgreementKpiBranchRow
{
    open var BranchName:String? = null
    open var ActiveCount:Int? = null
    open var Mrr:Double? = null
    open var ExpiringCount:Int? = null
    open var ChurnCount:Int? = null
    open var SkippedRate:Double? = null
}

Kotlin AgreementKpiRequest 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/dashboard/agreements HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FromDate: 0001-01-01,
	ToDate: 0001-01-01,
	LocationIds: 
	[
		00000000000000000000000000000000
	]
}

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
		}
	},
	Stats: 
	[
		{
			Key: String,
			Label: String,
			Value: 0,
			PreviousValue: 0,
			Unit: String
		}
	],
	ByBranch: 
	[
		{
			BranchName: String,
			ActiveCount: 0,
			Mrr: 0,
			ExpiringCount: 0,
			ChurnCount: 0,
			SkippedRate: 0
		}
	]
}