Trendsic Platform Service

<back to all web services

AgreementKpiRequest

Requires Authentication
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.*;

public class dtos
{

    public static class AgreementKpiRequest
    {
        public Date FromDate = null;
        public Date ToDate = null;
        public ArrayList<UUID> LocationIds = new ArrayList<UUID>();
        
        public Date getFromDate() { return FromDate; }
        public AgreementKpiRequest setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public AgreementKpiRequest setToDate(Date value) { this.ToDate = value; return this; }
        public ArrayList<UUID> getLocationIds() { return LocationIds; }
        public AgreementKpiRequest setLocationIds(ArrayList<UUID> value) { this.LocationIds = value; return this; }
    }

    public static class AgreementKpiResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<DashboardStatTile> Stats = new ArrayList<DashboardStatTile>();
        public ArrayList<AgreementKpiBranchRow> ByBranch = new ArrayList<AgreementKpiBranchRow>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AgreementKpiResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<DashboardStatTile> getStats() { return Stats; }
        public AgreementKpiResponse setStats(ArrayList<DashboardStatTile> value) { this.Stats = value; return this; }
        public ArrayList<AgreementKpiBranchRow> getByBranch() { return ByBranch; }
        public AgreementKpiResponse setByBranch(ArrayList<AgreementKpiBranchRow> value) { this.ByBranch = value; return this; }
    }

    public static class DashboardStatTile
    {
        public String Key = null;
        public String Label = null;
        public Double Value = null;
        public Double PreviousValue = null;
        public String Unit = null;
        public Double DeltaPct = null;
        
        public String getKey() { return Key; }
        public DashboardStatTile setKey(String value) { this.Key = value; return this; }
        public String getLabel() { return Label; }
        public DashboardStatTile setLabel(String value) { this.Label = value; return this; }
        public Double getValue() { return Value; }
        public DashboardStatTile setValue(Double value) { this.Value = value; return this; }
        public Double getPreviousValue() { return PreviousValue; }
        public DashboardStatTile setPreviousValue(Double value) { this.PreviousValue = value; return this; }
        public String getUnit() { return Unit; }
        public DashboardStatTile setUnit(String value) { this.Unit = value; return this; }
        public Double getDeltaPct() { return DeltaPct; }
        public DashboardStatTile setDeltaPct(Double value) { this.DeltaPct = value; return this; }
    }

    public static class AgreementKpiBranchRow
    {
        public String BranchName = null;
        public Integer ActiveCount = null;
        public Double Mrr = null;
        public Integer ExpiringCount = null;
        public Integer ChurnCount = null;
        public Double SkippedRate = null;
        
        public String getBranchName() { return BranchName; }
        public AgreementKpiBranchRow setBranchName(String value) { this.BranchName = value; return this; }
        public Integer getActiveCount() { return ActiveCount; }
        public AgreementKpiBranchRow setActiveCount(Integer value) { this.ActiveCount = value; return this; }
        public Double getMrr() { return Mrr; }
        public AgreementKpiBranchRow setMrr(Double value) { this.Mrr = value; return this; }
        public Integer getExpiringCount() { return ExpiringCount; }
        public AgreementKpiBranchRow setExpiringCount(Integer value) { this.ExpiringCount = value; return this; }
        public Integer getChurnCount() { return ChurnCount; }
        public AgreementKpiBranchRow setChurnCount(Integer value) { this.ChurnCount = value; return this; }
        public Double getSkippedRate() { return SkippedRate; }
        public AgreementKpiBranchRow setSkippedRate(Double value) { this.SkippedRate = value; return this; }
    }

}

Java AgreementKpiRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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}]}