| POST,OPTIONS | /v1/dashboard/kpiv2/visits |
|---|
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 KpiV2VisitsRequest
{
public virtual Guid BranchId { get; set; }
public virtual DateTime FromDate { get; set; }
public virtual DateTime ToDate { get; set; }
public virtual Guid? StationId { get; set; }
public virtual Guid? EmployeeId { get; set; }
public virtual string Outcome { get; set; }
public virtual Guid? LineId { get; set; }
public virtual int Page { get; set; }
public virtual int PageSize { get; set; }
}
public partial class KpiV2VisitsResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual SvcVisitPage Visits { get; set; }
}
public partial class SvcChip
{
public virtual Guid LineId { get; set; }
public virtual string Name { get; set; }
public virtual int N { get; set; }
}
public partial class SvcVisitPage
{
public virtual List<SvcVisitRow> Rows { get; set; } = [];
public virtual int TotalRows { get; set; }
public virtual int Page { get; set; }
public virtual int PageSize { get; set; }
public virtual Dictionary<string, int> OutcomeCounts { get; set; } = new();
public virtual List<SvcChip> Services { get; set; } = [];
public virtual bool CanSeeStaff { get; set; }
public virtual bool CanSeeFinancial { get; set; }
}
public partial class SvcVisitRow
{
public virtual Guid CheckinId { get; set; }
public virtual string TicketLabel { get; set; }
public virtual DateTime LocalDate { get; set; }
public virtual Guid LineId { get; set; }
public virtual string ServiceName { get; set; }
public virtual Guid? StationId { get; set; }
public virtual string StationName { get; set; }
public virtual Guid? EmployeeId { get; set; }
public virtual string EmployeeName { get; set; }
public virtual string CustomerName { get; set; }
public virtual int? ContactId { get; set; }
public virtual int? ContactAgentId { get; set; }
public virtual Guid CustomerId { get; set; }
public virtual bool IsAppointment { get; set; }
public virtual DateTime? LocalHere { get; set; }
public virtual DateTime? LocalCalled { get; set; }
public virtual DateTime? LocalStart { get; set; }
public virtual DateTime? LocalEnd { get; set; }
public virtual int? WaitSec { get; set; }
public virtual int? ServeSec { get; set; }
public virtual string Outcome { get; set; }
public virtual decimal? Fee { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dashboard/kpiv2/visits HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<KpiV2VisitsRequest 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>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<Outcome>String</Outcome>
<Page>0</Page>
<PageSize>0</PageSize>
<StationId>00000000-0000-0000-0000-000000000000</StationId>
<ToDate>0001-01-01T00:00:00</ToDate>
</KpiV2VisitsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<KpiV2VisitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<Visits>
<CanSeeFinancial>false</CanSeeFinancial>
<CanSeeStaff>false</CanSeeStaff>
<OutcomeCounts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringint>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>0</d3p1:Value>
</d3p1:KeyValueOfstringint>
</OutcomeCounts>
<Page>0</Page>
<PageSize>0</PageSize>
<Rows>
<SvcVisitRow>
<CheckinId>00000000-0000-0000-0000-000000000000</CheckinId>
<ContactAgentId>0</ContactAgentId>
<ContactId>0</ContactId>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>String</CustomerName>
<EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
<EmployeeName>String</EmployeeName>
<Fee>0</Fee>
<IsAppointment>false</IsAppointment>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LocalCalled>0001-01-01T00:00:00</LocalCalled>
<LocalDate>0001-01-01T00:00:00</LocalDate>
<LocalEnd>0001-01-01T00:00:00</LocalEnd>
<LocalHere>0001-01-01T00:00:00</LocalHere>
<LocalStart>0001-01-01T00:00:00</LocalStart>
<Outcome>String</Outcome>
<ServeSec>0</ServeSec>
<ServiceName>String</ServiceName>
<StationId>00000000-0000-0000-0000-000000000000</StationId>
<StationName>String</StationName>
<TicketLabel>String</TicketLabel>
<WaitSec>0</WaitSec>
</SvcVisitRow>
</Rows>
<Services>
<SvcChip>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<N>0</N>
<Name>String</Name>
</SvcChip>
</Services>
<TotalRows>0</TotalRows>
</Visits>
</KpiV2VisitsResponse>