| POST,OPTIONS | /v1/dashboard/agreements |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal
Namespace Global
Namespace CRM.AgencyPlatform.API.Internal
Public Partial Class AgreementKpiBranchRow
Public Overridable Property BranchName As String
Public Overridable Property ActiveCount As Integer
Public Overridable Property Mrr As Double
Public Overridable Property ExpiringCount As Integer
Public Overridable Property ChurnCount As Integer
Public Overridable Property SkippedRate As Double
End Class
Public Partial Class AgreementKpiRequest
Public Overridable Property FromDate As Date
Public Overridable Property ToDate As Date
Public Overridable Property LocationIds As List(Of Guid) = New List(Of Guid)
End Class
Public Partial Class AgreementKpiResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property Stats As List(Of DashboardStatTile) = New List(Of DashboardStatTile)
Public Overridable Property ByBranch As List(Of AgreementKpiBranchRow) = New List(Of AgreementKpiBranchRow)
End Class
Public Partial Class DashboardStatTile
Public Overridable Property Key As String
Public Overridable Property Label As String
Public Overridable Property Value As Double
Public Overridable Property PreviousValue As Double?
Public Overridable Property Unit As String
Public Overridable Property DeltaPct As Double?
End Class
End Namespace
End Namespace
VB.NET 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
}
]
}