| POST,OPTIONS | /v1/dashboard/agreements |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class AgreementKpiBranchRow
{
public virtual string BranchName { get; set; }
public virtual int ActiveCount { get; set; }
public virtual double Mrr { get; set; }
public virtual int ExpiringCount { get; set; }
public virtual int ChurnCount { get; set; }
public virtual double SkippedRate { get; set; }
}
public partial class AgreementKpiRequest
{
public virtual DateTime FromDate { get; set; }
public virtual DateTime ToDate { get; set; }
public virtual List<Guid> LocationIds { get; set; } = [];
}
public partial class AgreementKpiResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<DashboardStatTile> Stats { get; set; } = [];
public virtual List<AgreementKpiBranchRow> ByBranch { get; set; } = [];
}
public partial class DashboardStatTile
{
public virtual string Key { get; set; }
public virtual string Label { get; set; }
public virtual double Value { get; set; }
public virtual double? PreviousValue { get; set; }
public virtual string Unit { get; set; }
public virtual double? DeltaPct { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","LocationIds":["00000000000000000000000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/csv
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","DeltaPct":null}],"ByBranch":[{"BranchName":"String","ActiveCount":0,"Mrr":0,"ExpiringCount":0,"ChurnCount":0,"SkippedRate":0}]}