| POST,OPTIONS | /v1/dashboard/agreements |
|---|
import Foundation
import ServiceStack
public class AgreementKpiRequest : Codable
{
public var fromDate:Date
public var toDate:Date
public var locationIds:[String] = []
required public init(){}
}
public class AgreementKpiResponse : Codable
{
public var responseStatus:ResponseStatus
public var stats:[DashboardStatTile] = []
public var byBranch:[AgreementKpiBranchRow] = []
required public init(){}
}
public class DashboardStatTile : Codable
{
public var key:String
public var label:String
public var value:Double
public var previousValue:Double?
public var unit:String
public var deltaPct:Double?
required public init(){}
}
public class AgreementKpiBranchRow : Codable
{
public var branchName:String
public var activeCount:Int
public var mrr:Double
public var expiringCount:Int
public var churnCount:Int
public var skippedRate:Double
required public init(){}
}
Swift AgreementKpiRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}