Trendsic Platform Service

<back to all web services

AgreementKpiRequest

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

POST /v1/dashboard/agreements HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AgreementKpiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FromDate>0001-01-01T00:00:00</FromDate>
  <LocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </LocationIds>
  <ToDate>0001-01-01T00:00:00</ToDate>
</AgreementKpiRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementKpiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ByBranch>
    <AgreementKpiBranchRow>
      <ActiveCount>0</ActiveCount>
      <BranchName>String</BranchName>
      <ChurnCount>0</ChurnCount>
      <ExpiringCount>0</ExpiringCount>
      <Mrr>0</Mrr>
      <SkippedRate>0</SkippedRate>
    </AgreementKpiBranchRow>
  </ByBranch>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Stats>
    <DashboardStatTile>
      <Key>String</Key>
      <Label>String</Label>
      <PreviousValue>0</PreviousValue>
      <Unit>String</Unit>
      <Value>0</Value>
    </DashboardStatTile>
  </Stats>
</AgreementKpiResponse>