Trendsic Platform Service

KpiV2DetailRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dashboard/kpiv2/detail


export class SvcNamedTime
{
    public Id: string;
    public Name: string;
    public SignedSec: number;
    public Served: number;

    public constructor(init?: Partial<SvcNamedTime>) { (Object as any).assign(this, init); }
}

export class SvcTint
{
    public Field: string;
    public Tone: string;
    public Reason: string;
    public Value?: number;
    public Reference?: number;
    public BranchValue?: number;

    public constructor(init?: Partial<SvcTint>) { (Object as any).assign(this, init); }
}

export class SvcMetrics
{
    public Checkins: number;
    public Walkins: number;
    public Appts: number;
    public Served: number;
    public NoShows: number;
    public ApptNoShows: number;
    public CancelledAtWindow: number;
    public Abandoned: number;
    public Called: number;
    public CalledUp: number;
    public AbandonRate?: number;
    public NoShowRate?: number;
    public AvgServiceSec?: number;
    public MedianServiceSec?: number;
    public AvgWaitSec?: number;
    public MaxWaitSec: number;
    public AvgWalkUpSec?: number;
    public ExpectedServiceSec?: number;
    public SignedSec: number;
    public ServingSec: number;
    public PausedSec: number;
    public IdleSec: number;
    public UnstaffedSec: number;
    public Utilization?: number;
    public IdleShare?: number;
    public PausedShare?: number;
    public Sessions: number;
    public OpenDays: number;
    public FeesEarned?: number;
    public AvgFee?: number;
    public FeesPerStaffedHour?: number;
    public ExpectedFeesPerStaffedHour?: number;
    public LaborCost?: number;
    public LaborPartial: boolean;
    public MissingCostEmployeeIds: string[] = [];
    public MissingCost: SvcNamedTime[] = [];
    public LaborLocked: boolean;
    public Contribution?: number;
    public LostFees?: number;
    public LostNoShowFees?: number;
    public Mix: { [index:string]: number; } = {};
    public HourlyServed: number[] = [];
    public HourlyFees: number[] = [];
    public HourlyCost: number[] = [];
    public Tints: SvcTint[] = [];

    public constructor(init?: Partial<SvcMetrics>) { (Object as any).assign(this, init); }
}

export class SvcWindowRow
{
    public StationId: string;
    public Name: string;
    public Clerks: SvcNamedTime[] = [];
    public NeverStaffed: boolean;
    public LastStaffedUtc?: string;
    public LastStaffedBy: string;
    public Metrics: SvcMetrics;

    public constructor(init?: Partial<SvcWindowRow>) { (Object as any).assign(this, init); }
}

export class SvcClerkRow
{
    public EmployeeId: string;
    public Name: string;
    public Windows: SvcNamedTime[] = [];
    public LoadedRate?: number;
    public RateSet: boolean;
    public RateLocked: boolean;
    public Metrics: SvcMetrics;

    public constructor(init?: Partial<SvcClerkRow>) { (Object as any).assign(this, init); }
}

export class SvcAverage
{
    public Count: number;
    public Served: number;
    public AvgServiceSec?: number;
    public MedianServiceSec?: number;
    public AvgWaitSec?: number;
    public Utilization?: number;
    public IdleSec: number;
    public PausedSec: number;
    public NoShows: number;
    public SignedSec: number;
    public FeesEarned?: number;
    public FeesPerStaffedHour?: number;
    public LaborCost?: number;
    public Contribution?: number;
    public LostNoShowFees?: number;

    public constructor(init?: Partial<SvcAverage>) { (Object as any).assign(this, init); }
}

export class SvcSession
{
    public SessionId: string;
    public StationId: string;
    public StationName: string;
    public EmployeeId: string;
    public EmployeeName: string;
    public LocalIn: string;
    public LocalOut: string;
    public IsOpen: boolean;
    public EndReason: string;
    public PausedSec: number;

    public constructor(init?: Partial<SvcSession>) { (Object as any).assign(this, init); }
}

export class SvcFeeChange
{
    public LocationId: string;
    public OnDate: string;
    public FromFee: number;
    public ToFee: number;

    public constructor(init?: Partial<SvcFeeChange>) { (Object as any).assign(this, init); }
}

export class SvcServiceRow
{
    public LineId: string;
    public Name: string;
    public Completed: number;
    public AvgServiceSec?: number;
    public BranchAvgServiceSec?: number;
    public FeesEarned?: number;
    public FeeCurrent?: number;
    public FeeMin?: number;
    public FeeMax?: number;
    public FeePerMinute?: number;
    public BranchFeePerMinute?: number;
    public FeeChanges: SvcFeeChange[] = [];

    public constructor(init?: Partial<SvcServiceRow>) { (Object as any).assign(this, init); }
}

export class SvcDetail
{
    public Kind: string;
    public Window: SvcWindowRow;
    public Clerk: SvcClerkRow;
    public BranchMetrics: SvcMetrics;
    public PerRowAverage: SvcAverage;
    public Sessions: SvcSession[] = [];
    public Services: SvcServiceRow[] = [];
    public CanSeeStaff: boolean;
    public CanSeeFinancial: boolean;
    public CanSeePay: boolean;

    public constructor(init?: Partial<SvcDetail>) { (Object as any).assign(this, init); }
}

export class KpiV2DetailResponse
{
    public ResponseStatus: ResponseStatus;
    public Detail: SvcDetail;

    public constructor(init?: Partial<KpiV2DetailResponse>) { (Object as any).assign(this, init); }
}

export class KpiV2DetailRequest
{
    public BranchId: string;
    public StationId?: string;
    public EmployeeId?: string;
    public FromDate: string;
    public ToDate: string;

    public constructor(init?: Partial<KpiV2DetailRequest>) { (Object as any).assign(this, init); }
}

TypeScript KpiV2DetailRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

<KpiV2DetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <StationId>00000000-0000-0000-0000-000000000000</StationId>
  <ToDate>0001-01-01T00:00:00</ToDate>
</KpiV2DetailRequest>

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

<KpiV2DetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Detail>
    <BranchMetrics>
      <AbandonRate>0</AbandonRate>
      <Abandoned>0</Abandoned>
      <ApptNoShows>0</ApptNoShows>
      <Appts>0</Appts>
      <AvgFee>0</AvgFee>
      <AvgServiceSec>0</AvgServiceSec>
      <AvgWaitSec>0</AvgWaitSec>
      <AvgWalkUpSec>0</AvgWalkUpSec>
      <Called>0</Called>
      <CalledUp>0</CalledUp>
      <CancelledAtWindow>0</CancelledAtWindow>
      <Checkins>0</Checkins>
      <Contribution>0</Contribution>
      <ExpectedFeesPerStaffedHour>0</ExpectedFeesPerStaffedHour>
      <ExpectedServiceSec>0</ExpectedServiceSec>
      <FeesEarned>0</FeesEarned>
      <FeesPerStaffedHour>0</FeesPerStaffedHour>
      <HourlyCost xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>0</d4p1:decimal>
      </HourlyCost>
      <HourlyFees xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>0</d4p1:decimal>
      </HourlyFees>
      <HourlyServed xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </HourlyServed>
      <IdleSec>0</IdleSec>
      <IdleShare>0</IdleShare>
      <LaborCost>0</LaborCost>
      <LaborLocked>false</LaborLocked>
      <LaborPartial>false</LaborPartial>
      <LostFees>0</LostFees>
      <LostNoShowFees>0</LostNoShowFees>
      <MaxWaitSec>0</MaxWaitSec>
      <MedianServiceSec>0</MedianServiceSec>
      <MissingCost>
        <SvcNamedTime>
          <Id>00000000-0000-0000-0000-000000000000</Id>
          <Name>String</Name>
          <Served>0</Served>
          <SignedSec>0</SignedSec>
        </SvcNamedTime>
      </MissingCost>
      <MissingCostEmployeeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </MissingCostEmployeeIds>
      <Mix xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfguidint>
          <d4p1:Key>00000000-0000-0000-0000-000000000000</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfguidint>
      </Mix>
      <NoShowRate>0</NoShowRate>
      <NoShows>0</NoShows>
      <OpenDays>0</OpenDays>
      <PausedSec>0</PausedSec>
      <PausedShare>0</PausedShare>
      <Served>0</Served>
      <ServingSec>0</ServingSec>
      <Sessions>0</Sessions>
      <SignedSec>0</SignedSec>
      <Tints>
        <SvcTint>
          <BranchValue>0</BranchValue>
          <Field>String</Field>
          <Reason>String</Reason>
          <Reference>0</Reference>
          <Tone>String</Tone>
          <Value>0</Value>
        </SvcTint>
      </Tints>
      <UnstaffedSec>0</UnstaffedSec>
      <Utilization>0</Utilization>
      <Walkins>0</Walkins>
    </BranchMetrics>
    <CanSeeFinancial>false</CanSeeFinancial>
    <CanSeePay>false</CanSeePay>
    <CanSeeStaff>false</CanSeeStaff>
    <Clerk>
      <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
      <LoadedRate>0</LoadedRate>
      <Metrics>
        <AbandonRate>0</AbandonRate>
        <Abandoned>0</Abandoned>
        <ApptNoShows>0</ApptNoShows>
        <Appts>0</Appts>
        <AvgFee>0</AvgFee>
        <AvgServiceSec>0</AvgServiceSec>
        <AvgWaitSec>0</AvgWaitSec>
        <AvgWalkUpSec>0</AvgWalkUpSec>
        <Called>0</Called>
        <CalledUp>0</CalledUp>
        <CancelledAtWindow>0</CancelledAtWindow>
        <Checkins>0</Checkins>
        <Contribution>0</Contribution>
        <ExpectedFeesPerStaffedHour>0</ExpectedFeesPerStaffedHour>
        <ExpectedServiceSec>0</ExpectedServiceSec>
        <FeesEarned>0</FeesEarned>
        <FeesPerStaffedHour>0</FeesPerStaffedHour>
        <HourlyCost xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:decimal>0</d5p1:decimal>
        </HourlyCost>
        <HourlyFees xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:decimal>0</d5p1:decimal>
        </HourlyFees>
        <HourlyServed xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </HourlyServed>
        <IdleSec>0</IdleSec>
        <IdleShare>0</IdleShare>
        <LaborCost>0</LaborCost>
        <LaborLocked>false</LaborLocked>
        <LaborPartial>false</LaborPartial>
        <LostFees>0</LostFees>
        <LostNoShowFees>0</LostNoShowFees>
        <MaxWaitSec>0</MaxWaitSec>
        <MedianServiceSec>0</MedianServiceSec>
        <MissingCost>
          <SvcNamedTime>
            <Id>00000000-0000-0000-0000-000000000000</Id>
            <Name>String</Name>
            <Served>0</Served>
            <SignedSec>0</SignedSec>
          </SvcNamedTime>
        </MissingCost>
        <MissingCostEmployeeIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>00000000-0000-0000-0000-000000000000</d5p1:guid>
        </MissingCostEmployeeIds>
        <Mix xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfguidint>
            <d5p1:Key>00000000-0000-0000-0000-000000000000</d5p1:Key>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:KeyValueOfguidint>
        </Mix>
        <NoShowRate>0</NoShowRate>
        <NoShows>0</NoShows>
        <OpenDays>0</OpenDays>
        <PausedSec>0</PausedSec>
        <PausedShare>0</PausedShare>
        <Served>0</Served>
        <ServingSec>0</ServingSec>
        <Sessions>0</Sessions>
        <SignedSec>0</SignedSec>
        <Tints>
          <SvcTint>
            <BranchValue>0</BranchValue>
            <Field>String</Field>
            <Reason>String</Reason>
            <Reference>0</Reference>
            <Tone>String</Tone>
            <Value>0</Value>
          </SvcTint>
        </Tints>
        <UnstaffedSec>0</UnstaffedSec>
        <Utilization>0</Utilization>
        <Walkins>0</Walkins>
      </Metrics>
      <Name>String</Name>
      <RateLocked>false</RateLocked>
      <RateSet>false</RateSet>
      <Windows>
        <SvcNamedTime>
          <Id>00000000-0000-0000-0000-000000000000</Id>
          <Name>String</Name>
          <Served>0</Served>
          <SignedSec>0</SignedSec>
        </SvcNamedTime>
      </Windows>
    </Clerk>
    <Kind>String</Kind>
    <PerRowAverage>
      <AvgServiceSec>0</AvgServiceSec>
      <AvgWaitSec>0</AvgWaitSec>
      <Contribution>0</Contribution>
      <Count>0</Count>
      <FeesEarned>0</FeesEarned>
      <FeesPerStaffedHour>0</FeesPerStaffedHour>
      <IdleSec>0</IdleSec>
      <LaborCost>0</LaborCost>
      <LostNoShowFees>0</LostNoShowFees>
      <MedianServiceSec>0</MedianServiceSec>
      <NoShows>0</NoShows>
      <PausedSec>0</PausedSec>
      <Served>0</Served>
      <SignedSec>0</SignedSec>
      <Utilization>0</Utilization>
    </PerRowAverage>
    <Services>
      <SvcServiceRow>
        <AvgServiceSec>0</AvgServiceSec>
        <BranchAvgServiceSec>0</BranchAvgServiceSec>
        <BranchFeePerMinute>0</BranchFeePerMinute>
        <Completed>0</Completed>
        <FeeChanges>
          <SvcFeeChange>
            <FromFee>0</FromFee>
            <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
            <OnDate>0001-01-01T00:00:00</OnDate>
            <ToFee>0</ToFee>
          </SvcFeeChange>
        </FeeChanges>
        <FeeCurrent>0</FeeCurrent>
        <FeeMax>0</FeeMax>
        <FeeMin>0</FeeMin>
        <FeePerMinute>0</FeePerMinute>
        <FeesEarned>0</FeesEarned>
        <LineId>00000000-0000-0000-0000-000000000000</LineId>
        <Name>String</Name>
      </SvcServiceRow>
    </Services>
    <Sessions>
      <SvcSession>
        <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
        <EmployeeName>String</EmployeeName>
        <EndReason>String</EndReason>
        <IsOpen>false</IsOpen>
        <LocalIn>0001-01-01T00:00:00</LocalIn>
        <LocalOut>0001-01-01T00:00:00</LocalOut>
        <PausedSec>0</PausedSec>
        <SessionId>00000000-0000-0000-0000-000000000000</SessionId>
        <StationId>00000000-0000-0000-0000-000000000000</StationId>
        <StationName>String</StationName>
      </SvcSession>
    </Sessions>
    <Window>
      <Clerks>
        <SvcNamedTime>
          <Id>00000000-0000-0000-0000-000000000000</Id>
          <Name>String</Name>
          <Served>0</Served>
          <SignedSec>0</SignedSec>
        </SvcNamedTime>
      </Clerks>
      <LastStaffedBy>String</LastStaffedBy>
      <LastStaffedUtc>0001-01-01T00:00:00</LastStaffedUtc>
      <Metrics>
        <AbandonRate>0</AbandonRate>
        <Abandoned>0</Abandoned>
        <ApptNoShows>0</ApptNoShows>
        <Appts>0</Appts>
        <AvgFee>0</AvgFee>
        <AvgServiceSec>0</AvgServiceSec>
        <AvgWaitSec>0</AvgWaitSec>
        <AvgWalkUpSec>0</AvgWalkUpSec>
        <Called>0</Called>
        <CalledUp>0</CalledUp>
        <CancelledAtWindow>0</CancelledAtWindow>
        <Checkins>0</Checkins>
        <Contribution>0</Contribution>
        <ExpectedFeesPerStaffedHour>0</ExpectedFeesPerStaffedHour>
        <ExpectedServiceSec>0</ExpectedServiceSec>
        <FeesEarned>0</FeesEarned>
        <FeesPerStaffedHour>0</FeesPerStaffedHour>
        <HourlyCost xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:decimal>0</d5p1:decimal>
        </HourlyCost>
        <HourlyFees xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:decimal>0</d5p1:decimal>
        </HourlyFees>
        <HourlyServed xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </HourlyServed>
        <IdleSec>0</IdleSec>
        <IdleShare>0</IdleShare>
        <LaborCost>0</LaborCost>
        <LaborLocked>false</LaborLocked>
        <LaborPartial>false</LaborPartial>
        <LostFees>0</LostFees>
        <LostNoShowFees>0</LostNoShowFees>
        <MaxWaitSec>0</MaxWaitSec>
        <MedianServiceSec>0</MedianServiceSec>
        <MissingCost>
          <SvcNamedTime>
            <Id>00000000-0000-0000-0000-000000000000</Id>
            <Name>String</Name>
            <Served>0</Served>
            <SignedSec>0</SignedSec>
          </SvcNamedTime>
        </MissingCost>
        <MissingCostEmployeeIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>00000000-0000-0000-0000-000000000000</d5p1:guid>
        </MissingCostEmployeeIds>
        <Mix xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfguidint>
            <d5p1:Key>00000000-0000-0000-0000-000000000000</d5p1:Key>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:KeyValueOfguidint>
        </Mix>
        <NoShowRate>0</NoShowRate>
        <NoShows>0</NoShows>
        <OpenDays>0</OpenDays>
        <PausedSec>0</PausedSec>
        <PausedShare>0</PausedShare>
        <Served>0</Served>
        <ServingSec>0</ServingSec>
        <Sessions>0</Sessions>
        <SignedSec>0</SignedSec>
        <Tints>
          <SvcTint>
            <BranchValue>0</BranchValue>
            <Field>String</Field>
            <Reason>String</Reason>
            <Reference>0</Reference>
            <Tone>String</Tone>
            <Value>0</Value>
          </SvcTint>
        </Tints>
        <UnstaffedSec>0</UnstaffedSec>
        <Utilization>0</Utilization>
        <Walkins>0</Walkins>
      </Metrics>
      <Name>String</Name>
      <NeverStaffed>false</NeverStaffed>
      <StationId>00000000-0000-0000-0000-000000000000</StationId>
    </Window>
  </Detail>
  <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>
</KpiV2DetailResponse>